Updated per the latest changes

[mirror_edk2.git] / BaseTools / ChangeLog.txt

##########################################################################################\r
!!!!!!!!!!!!!!!!!               Notes for this ChangeLog.txt             !!!!!!!!!!!!!!!!!\r
\r
This log file is used to record two kinds of important information:\r
 a) "Non-Compatible Changes": all non-compatible changes should be recorded. These info\r
    will help the package user to merge this package; and some non-compatible changes\r
    can also be added into release notes as news features when we release this package.\r
    Normally Non-Compatible Changes contains the following types:\r
      1) Package's external services were changed/updated\r
      2) Package's common .h file is renamed, deleted, or the file path is changed.\r
      3) The definition of package's common data structure is changed\r
      ...\r
\r
 b) "Important Compatible Changes": some important compatible changes can aslo be recorded\r
    in this file, and we can add these updating into release notes when we release this\r
    package.\r
\r
Non-Compatible and Compatible example format:\r
==========================================================================================\r
EDK_0010: Non-Compatible: owner\r
\r
      Class_HFile: PPI A of MdePkg has been removed.\r
\r
        Code Change :\r
        1) Removed the .h file: MdePkg\Include\Ppi\A.h\r
\r
        Possible Impacts:\r
        1) All modules that used this PPI A should be updated.\r
\r
==========================================================================================\r
EDK_0000: Compatible: owner\r
\r
      Class_BuildTool: with the EDK_0000 build.exe, the build performance is enhanced great.\r
\r
        Code Change :\r
        1) BaseTools\Bin\Win32\build.exe\r
\r
!!!!!!!!!!!!!!!!!!                     End of Notes                     !!!!!!!!!!!!!!!!!!\r
\r
##########################################################################################\r
\r
##########################################################################################\r
##########                 Revision number of tools source code                 ##########\r
    BaseTools/Bin/Win32/build.exe\r
        r1483 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/Autogen\r
        r1483 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/build\r
        r1483 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/Common\r
        r1483 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/CommonDataClass\r
        r1483 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/GenFds\r
        r1483 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/Workspace\r
\r
    BaseTools/Bin/Win32/GenFds.exe\r
        r1483 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/Common\r
        r1483 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/CommonDataClass\r
        r1483 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/GenFds\r
        r1483 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/Workspace\r
\r
    BaseTools/Bin/Win32/GenDepex.exe\r
        r1383 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/AutoGen\r
        r1383 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/Common\r
\r
    BaseTools/Bin/Win32/Trim.exe\r
        r1483 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/Trim\r
        r1483 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/Common\r
\r
    BaseTools/Bin/Win32/MigrationMsa2Inf.exe\r
        r843 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/MigrationMsa2Inf\r
        r843 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/Common\r
\r
    BaseTools/Bin/Win32/TargetTool.exe\r
        r843 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/TargetTool\r
        r843 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/Common\r
\r
    BaseTools/Bin/Win32/Spd2Dec.exe\r
        r777 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/spd2dec\r
\r
    BaseTools/Bin/Win32/Fpd2Dsc.exe\r
        r767 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/fpd2dsc\r
\r
==========================================================================================\r
basetools_7529: Non-Compatible: jwang36\r
\r
      Class_BuildTool:\r
        1) Use FAMILY defined in *_TAGNAME_*_*_FAMILY as the toolchain family\r
        2) Force file name case check in Windows\r
        3) Consolidate file/path operations\r
        4) Support binary file type in build_rule.txt\r
        5) Generate $(FILE_TYPES) macro only when it's used in build_rule.txt\r
        6) Use build_rule.txt to solve customized build for USER_DEFINED module\r
        7) Re-design TemplateString to make it faster\r
        8) Improve performance of Trim tool\r
        9) Fix undefined variables issue\r
        10) Fix HSD202142 and HSD202144\r
\r
        Code Change :\r
        1) /trunk/edk2/BaseTools/Bin/Win32/build.exe\r
        2) /trunk/edk2/BaseTools/Bin/Win32/GenFds.exe\r
        3) /trunk/edk2/BaseTools/Bin/Win32/Trim.exe\r
        4) /trunk/edk2/BaseTools/Conf/build_rule.template\r
\r
        Possible Impacts:\r
        1) To build Nt32Pkg.dsc correctly, the local version build_rule.txt must\r
           updated with the change in new build_rule.template.\r
        2) The case of file path must be the same as in file system, or the build\r
           will break.\r
\r
basetools_7159: Non-Compatible: jwang36\r
\r
      Class_BuildTool:\r
        1) Re-fine and fully test the mechanism of getting over the long command\r
           line limitation\r
        2) Change the -s option of build from "SpawnMode" to be "SilentMode"\r
        3) Change the prototype of PeiCoreEntryPoint in AutoGen-ed code\r
        4) Remove CalcDeps module since it's no longer needed.\r
        5) Remove "-k", "-g" and "-l" switches from build\r
        6) Remove MULTIPLE_THREAD in target.template. Use MAX_CONCURRENT_THREAD_NUMBER\r
           to get the same functionality.\r
\r
        Code Change :\r
        1) /trunk/edk2/BaseTools/Bin/Win32/build.exe\r
        1) /trunk/edk2/BaseTools/Bin/Win32/GenFds.exe\r
\r
        Possible Impacts:\r
        1) The local version build_rule.txt must be updated with changes in build_rule.template\r
        2) Use "build -s" to pass "-s" switch to "make" tool to do silent "make".\r
           To suppress all message from stdout, use "build -q" instead.\r
        3) To get over the long command line limitation, use "@$(<FILE_TYPE>S_LIST)"\r
           in the place of ${src} for those commands encountering such kind of\r
           problem.\r
\r
basetools_7009: Non-Compatible: jwang36\r
\r
      Class_BuildTool:\r
        1) Search value of Guid/Protocol/PPI in inf file only in the same category in dec file.\r
        2) Pass all files in a module's directory to StrGather for R8 modules.\r
\r
        Code Change :\r
        1) /trunk/edk2/BaseTools/Bin/Win32/build.exe\r
\r
        Possible Impacts:\r
        1) Those inf files in which the PPI/Protocol/Guid are put in incorrect\r
           section will encounter build break.\r
\r
==========================================================================================\r
EDK_6930: Non-Compatible: jwang36\r
\r
      Class_BuildTool:\r
        1) Separate the AutoGen code for PCDs between module and its library instances.\r
           Only macros for module's PCDs will be put in AutoGen.h. Others will be put\r
           in AutoGen.c. This is intended to catch missed PCDs in inf file more easily.\r
        2) For better compatibile between C standards or C compiler, add type cast for\r
           PCD constants in AutoGen.h according to the PCD datum type.\r
        3) Add incremental generation capability for FV in GenFds tool.\r
\r
        Code Change :\r
        1) /trunk/edk2/BaseTools/Bin/Win32/build.exe\r
        2) /trunk/edk2/BaseTools/Bin/Win32/GenFds.exe\r
\r
        Possible Impacts:\r
        1) If there're PCDs used in a module but not declared in the module's inf file,\r
           and occasionally they are declared in the library instances, there must be\r
           a build break. Adding necessary PCDs declarations in the module's inf file\r
           will solve it.\r
\r
==========================================================================================\r
EDK_6828: Compatible: jwang36\r
\r
      Class_BuildTool:\r
        1) Add a feature to allow override tools option via "==" in metafile.\r
        2) Remove the AutoGen.c generation for R8 module without unicode file.\r
\r
\r
        Code Change :\r
        1) /trunk/edk2/BaseTools/Bin/Win32/build.exe\r
\r
==========================================================================================\r
EDK_6772: Non-Compatible: jwang36\r
\r
      Class_BuildTool:\r
        1) Add /D$(MODULE_ENTRY_POINT)=$(ARCH_ENTRY_POINT) in EBC_CC_FLAGS to ensure\r
           correct R8's module entry point for EBC arch.\r
\r
        Code Change :\r
        1) /trunk/edk2/BaseTools/Conf/tools_def.template\r
\r
        Possible Impacts:\r
           The local version of tools_def.txt must be updated with the change in\r
           tools_def.template.\r
\r
==========================================================================================\r
EDK_6762: Non-Compatible: lgao4\r
\r
      Class_BuildTool:\r
        1) Declare entry point, constructor into AutoGen.h\r
        2) Create <ModuleName>StrDefs.h to contain uni code string ID.\r
\r
\r
        Code Change :\r
        1) /trunk/edk2/BaseTools/Bin/Win32/build.exe\r
        2) /trunk/edk2/BaseTools/Conf/tools_def.template\r
\r
        Possible Impacts:\r
           The local version of tools_def.txt must be updated with change in\r
           tools_def.tempalte.\r
\r
==========================================================================================\r
EDK_6671: Compatible: qwang12\r
\r
      Class_BuildTool:\r
        1) StrGather (Build.exe) in compatible mode add a Framework Package Header\r