BaseTools/ChangeLog.txt

   1 ##########################################################################################
   2 !!!!!!!!!!!!!!!!!               Notes for this ChangeLog.txt             !!!!!!!!!!!!!!!!!
   3
   4 This log file is used to record two kinds of important information:
   5  a) "Non-Compatible Changes": all non-compatible changes should be recorded. These info
   6     will help the package user to merge this package; and some non-compatible changes
   7     can also be added into release notes as news features when we release this package.
   8     Normally Non-Compatible Changes contains the following types:
   9       1) Package's external services were changed/updated
  10       2) Package's common .h file is renamed, deleted, or the file path is changed.
  11       3) The definition of package's common data structure is changed
  12       ...
  13
  14  b) "Important Compatible Changes": some important compatible changes can aslo be recorded
  15     in this file, and we can add these updating into release notes when we release this
  16     package.
  17
  18 Non-Compatible and Compatible example format:
  19 ==========================================================================================
  20 EDK_0010: Non-Compatible: owner
  21
  22       Class_HFile: PPI A of MdePkg has been removed.
  23
  24         Code Change :
  25         1) Removed the .h file: MdePkg\Include\Ppi\A.h
  26
  27         Possible Impacts:
  28         1) All modules that used this PPI A should be updated.
  29
  30 ==========================================================================================
  31 EDK_0000: Compatible: owner
  32
  33       Class_BuildTool: with the EDK_0000 build.exe, the build performance is enhanced great.
  34
  35         Code Change :
  36         1) BaseTools\Bin\Win32\build.exe
  37
  38 !!!!!!!!!!!!!!!!!!                     End of Notes                     !!!!!!!!!!!!!!!!!!
  39 ##########################################################################################
  40
  41
  42 ==========================================================================================
  43 EDK_3832: Non-Compatible: jwang36
  44
  45       Class_BuildTool:
  46         1) Added support of MACRO in tools_def.txt
  47         2) Merged PATH and NAME attributes in tools_def.txt
  48         3) Changed DPATH attribute to DLL in tools_def.txt
  49         4) Removed SPATH attribute in tools_def.txt
  50         5) Added support for library instance without library class
  51         6) Fixed the issue in Trim tool which zero file will be generated if the trimmed
  52            file has not line directive
  53
  54         Code Change :
  55         1) BaseTools/Bin/Win32/build.exe
  56         2) BaseTools/Bin/Win32/GenFds.exe
  57         3) BaseTools/Bin/Win32/Trim.exe
  58         4) BaseTools/Conf/tools_def.template
  59
  60         Possible Impacts:
  61         1) All platforms and modules build
  62
  63 ==========================================================================================
  64 EDK_3801: Compatible: jwang36
  65
  66       Class_BuildConfiguration: Added makefile as dependency for "Dynamic-Library-File" to
  67         solve the incremental build issue occurred when there's library changes
  68
  69         Code Change :
  70         1) BaseTools/Conf/build_rule.template
  71
  72 ==========================================================================================
  73 EDK_3800: Compatible: lgao4
  74
  75       Class_BuildTool: Update EfiRom tool to fix checksum and PCI3.0 data structure
  76
  77         Code Change :
  78         1) BaseTools/Bin/Win32/EfiRom.exe
  79
  80 ==========================================================================================
  81 EDK_3795: Compatible: htao
  82
  83       Class_BuildTool: GenVtf tool open/write file with "r+b"/"w+b" attribute, but this cause
  84                        the RO attribute of the file changed. Fix this issue by changing
  85                        "r+b"/"w+b" to "rb"/"wb".
  86
  87         Code Change :
  88         1) BaseTools/Bin/Win32/GenVtf.exe
  89
  90 ==========================================================================================
  91 EDK_3791: Compatible: jlin16
  92
  93       Class_BuildTool:
  94         1) use '#' to indicate flash generation progress.
  95         2) use -v to switch on detail output messages.
  96
  97         Code Change :
  98         1) BaseTools/Bin/Win32/GenFds.exe
  99
 100 ==========================================================================================
 101 EDK_3789: Non-Compatible: lgao4
 102
 103       Class_BuildTool: support new Rules format and PCD format defined in FDF file
 104
 105         Code Change :
 106         1) BaseTools/Bin/Win32/build.exe
 107         2) BaseTools/Bin/Win32/GenFds.exe
 108
 109         Possible Impacts:
 110         1) All platform's FDF file, if any, must be changed to new format.
 111           a) PCD format is changed from old PcdName to new PcdTokenSpaceGuid.PcdName, for example PcdWinNtFdBaseAddress in old FDF file will be replaced by gEfiNt32PkgTokenSpaceGuid.PcdWinNtFdBaseAddres.
 112           b) Rule format adds binary file type and file postfix name support, and doesn't require the full file path. For example:
 113           Old Peim Rule:
 114           [Rule.Common.PEIM]
 115           FILE PEIM = $(NAMED_GUID) {
 116              PEI_DEPEX Optional        $(INF_OUTPUT)/$(MODULE_NAME).Depex
 117              PE32                      $(INF_OUTPUT)/$(MODULE_NAME).efi
 118              UI Optional               $(MODULE_NAME)
 119              VERSION Optional          BUILD_NUM=$(BUILD_NUMBER) $(INF_VERSION)
 120           }
 121           New Peim Rule:
 122           [Rule.Common.PEIM]
 123             FILE PEIM = $(NAMED_GUID) {
 124                PEI_DEPEX PEI_DEPEX Optional        |.Depex
 125                PE32      PE32                      |.efi
 126                UI       STRING="$(MODULE_NAME)" Optional
 127                VERSION  STRING="$(INF_VERSION)" Optional BUILD_NUM=$(BUILD_NUMBER)
 128             }
 129
 130 ==========================================================================================
 131 EDK_3786: Compatible: vjeff
 132
 133       Class_BuildConfiguration:
 134         1) Redirect ICC_IA32_*_PATH from C:\Program Files\Microsoft Visual Studio .NET 2003\Vc7\bin
 135            to C:\Program Files\Intel\Compiler\C++\9.1\IA32\Bin.
 136         2) Add ICC X64 definition to enable ICC X64 build.
 137
 138         Code Change :
 139         1) BaseTools/Conf/tools_def.template
 140
 141 ==========================================================================================
 142 EDK_3785: Non-Compatible: klu2
 143
 144       Class_BuildTool: Upgrade the format of EFI_PEIM_ENTRY_POINT to
 145                        EFI_PEIM_ENTRY_POINT2 according to PI specification.
 146
 147
 148         Code Change :
 149         1) BaseTools/Bin/Win32/build.exe
 150
 151         Possible Impacts:
 152         1) All modules build
 153
 154
 155 ==========================================================================================
 156 EDK_3780: Non-Compatible: qhuang8
 157
 158       Class_MigrationTool: Update the syntax of PCD section.
 159                            Update the syntax of binary INF file
 160                            The generated Extended INF file should follow Extended INF spec 0.44
 161
 162         Code Change :
 163         1) BaseTools/Bin/Win32/MigrationMsa2Inf.exe
 164
 165         Possible Impacts:
 166         1) New module migrated from old R9
 167
 168
 169 ==========================================================================================
 170 EDK_3766: Non-Compatible: lgao4
 171
 172       Class_BuildConfiguration: Update Acpi Asl file Build rule to remove trim step.
 173
 174         Code Change :
 175         1) Conf/build_rule.template
 176
 177         Possible Impacts:
 178         1) Platform with ACPI module. Acpi module needs to set /EP preprocessor compiler option for APP_FLAGS in module inf to override the default /E option from tools_def.txt file.
 179
 180