Adding the ChangeLog.txt file to this sub-project
authorlhauch <lhauch@7335b38e-4728-0410-8992-fb3ffe349368>
Wed, 26 Sep 2007 17:38:06 +0000 (17:38 +0000)
committerlhauch <lhauch@7335b38e-4728-0410-8992-fb3ffe349368>
Wed, 26 Sep 2007 17:38:06 +0000 (17:38 +0000)
git-svn-id: https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools@760 7335b38e-4728-0410-8992-fb3ffe349368

ChangeLog.txt [new file with mode: 0755]

diff --git a/ChangeLog.txt b/ChangeLog.txt
new file mode 100755 (executable)
index 0000000..9a047f5
--- /dev/null
@@ -0,0 +1,235 @@
+##########################################################################################\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
+EDK_3926: Compatible: jlin16\r
+\r
+      Class_BuildTool:\r
+        1) Added support of Capsule generation from FDF file.\r
\r
+        Code Change :\r
+        1) BaseTools/Bin/Win32/build.exe\r
+        2) BaseTools/Bin/Win32/GenFds.exe\r
+\r
+        Possible Impacts:\r
+        1) To generate capsule, insert [Capsule] section after [FV] sections and specifying\r
+        what FV will be put into capsule, For example:\r
+        [Capsule.Fob]\r
+        CAPSULE_GUID = 3B6686BD-0D76-4030-B70E-B5519E2FC5A0\r
+        CAPSULE_FLAG = PersistAcrossReset\r
+        FV = BiosUpdate\r
+\r
+==========================================================================================\r
+EDK_3911: Compatible: jlin16\r
+\r
+      Class_BuildTool:\r
+        1) Added support of Apriori file generation from FDF file.\r
+        2) Added support of INF that describes binary files to put binary into FV.\r
+        3) Fixed single FV/FD generation error when specifying -i/-r option in GenFds.\r
+        \r
\r
+        Code Change :\r
+        1) BaseTools/Bin/Win32/build.exe\r
+        2) BaseTools/Bin/Win32/GenFds.exe\r
+\r
+        Possible Impacts:\r
+        1) To generate Apriori file in FV, insert APRIORI statement just before the INF or\r
+        FILE statement list of the FV, For example:\r
+        APRIORI PEI {\r
+          INF  MdeModulePkg/Universal/PCD/Pei/Pcd.inf\r
+          FILE PEIM = B7A5041A-78BA-49e3-B73B-54C757811FB6 {\r
+                  SECTION PE32 = MyBinPkg\bin\ia32\PeimAfterPcd.efi\r
+          }\r
+          INF  IntelFrameworkModulePkg/Universal/StatusCode/Pei/PeiStatusCode.inf\r
+        }\r
+        2) To add binary file described by INF file into FV, only insert the INF statement\r
+        into the INF statements list of that FV, like this:\r
+        \r
+        INF RuleOverride=Test MdeModulePkg/Logo/Logo.inf\r
+        \r
+        Specifying how to process the binary file by defining corresponding Rule like this:\r
+        [Rule.Common.Base.Test]\r
+              FILE FREEFORM = $(NAMED_GUID) {\r
+                COMPRESS PI_STD {\r
+                GUIDED {\r
+                RAW BIN |.bmp   \r
+             }\r
+                }\r
+              }\r
+\r
+==========================================================================================\r
+EDK_3832: Non-Compatible: jwang36\r
+\r
+      Class_BuildTool:\r
+        1) Added support of MACRO in tools_def.txt\r
+        2) Merged PATH and NAME attributes in tools_def.txt\r
+        3) Changed DPATH attribute to DLL in tools_def.txt\r
+        4) Removed SPATH attribute in tools_def.txt\r
+        5) Added support for library instance without library class\r
+        6) Fixed the issue in Trim tool which zero file will be generated if the trimmed \r
+           file has not line directive\r
\r
+        Code Change :\r
+        1) BaseTools/Bin/Win32/build.exe\r
+        2) BaseTools/Bin/Win32/GenFds.exe\r
+        3) BaseTools/Bin/Win32/Trim.exe\r
+        4) BaseTools/Conf/tools_def.template\r
+\r
+        Possible Impacts:\r
+        1) All platforms and modules build\r
+\r
+==========================================================================================\r
+EDK_3801: Compatible: jwang36\r
+\r
+      Class_BuildConfiguration: Added makefile as dependency for "Dynamic-Library-File" to \r
+        solve the incremental build issue occurred when there's library changes\r
+\r
+        Code Change :\r
+        1) BaseTools/Conf/build_rule.template\r
+\r
+==========================================================================================\r
+EDK_3800: Compatible: lgao4\r
+\r
+      Class_BuildTool: Update EfiRom tool to fix checksum and PCI3.0 data structure\r
+\r
+        Code Change :\r
+        1) BaseTools/Bin/Win32/EfiRom.exe\r
+\r
+==========================================================================================\r
+EDK_3795: Compatible: htao\r
+\r
+      Class_BuildTool: GenVtf tool open/write file with "r+b"/"w+b" attribute, but this cause\r
+                       the RO attribute of the file changed. Fix this issue by changing \r
+                       "r+b"/"w+b" to "rb"/"wb".\r
+\r
+        Code Change :\r
+        1) BaseTools/Bin/Win32/GenVtf.exe\r
+\r
+==========================================================================================\r
+EDK_3791: Compatible: jlin16\r
+\r
+      Class_BuildTool:\r
+        1) use '#' to indicate flash generation progress.\r
+        2) use -v to switch on detail output messages.\r
+\r
+        Code Change :\r
+        1) BaseTools/Bin/Win32/GenFds.exe\r
+\r
+==========================================================================================\r
+EDK_3789: Non-Compatible: lgao4\r
+\r
+      Class_BuildTool: support new Rules format and PCD format defined in FDF file\r
+\r
+        Code Change :\r
+        1) BaseTools/Bin/Win32/build.exe\r
+        2) BaseTools/Bin/Win32/GenFds.exe\r
+\r
+        Possible Impacts:\r
+        1) All platform's FDF file, if any, must be changed to new format.\r
+          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.\r
+          b) Rule format adds binary file type and file postfix name support, and doesn't require the full file path. For example:\r
+          Old Peim Rule:\r
+          [Rule.Common.PEIM]\r
+          FILE PEIM = $(NAMED_GUID) {\r
+             PEI_DEPEX Optional        $(INF_OUTPUT)/$(MODULE_NAME).Depex\r
+             PE32                      $(INF_OUTPUT)/$(MODULE_NAME).efi\r
+             UI Optional               $(MODULE_NAME)\r
+             VERSION Optional          BUILD_NUM=$(BUILD_NUMBER) $(INF_VERSION)\r
+          }\r
+          New Peim Rule:\r
+          [Rule.Common.PEIM]\r
+            FILE PEIM = $(NAMED_GUID) {\r
+               PEI_DEPEX PEI_DEPEX Optional        |.Depex\r
+               PE32      PE32                      |.efi\r
+               UI       STRING="$(MODULE_NAME)" Optional         \r
+               VERSION  STRING="$(INF_VERSION)" Optional BUILD_NUM=$(BUILD_NUMBER)   \r
+            }\r
+\r
+==========================================================================================\r
+EDK_3786: Compatible: vjeff\r
+\r
+      Class_BuildConfiguration:\r
+        1) Redirect ICC_IA32_*_PATH from C:\Program Files\Microsoft Visual Studio .NET 2003\Vc7\bin \r
+           to C:\Program Files\Intel\Compiler\C++\9.1\IA32\Bin. \r
+        2) Add ICC X64 definition to enable ICC X64 build.\r
+\r
+        Code Change :\r
+        1) BaseTools/Conf/tools_def.template\r
+\r
+==========================================================================================\r
+EDK_3785: Non-Compatible: klu2\r
+\r
+      Class_BuildTool: Upgrade the format of EFI_PEIM_ENTRY_POINT to \r
+                       EFI_PEIM_ENTRY_POINT2 according to PI specification.\r
+\r
+\r
+        Code Change :\r
+        1) BaseTools/Bin/Win32/build.exe\r
+\r
+        Possible Impacts:\r
+        1) All modules build\r
+\r
+\r
+==========================================================================================\r
+EDK_3780: Non-Compatible: qhuang8\r
+\r
+      Class_MigrationTool: Update the syntax of PCD section.\r
+                           Update the syntax of binary INF file\r
+                           The generated Extended INF file should follow Extended INF spec 0.44\r
+\r
+        Code Change :\r
+        1) BaseTools/Bin/Win32/MigrationMsa2Inf.exe\r
+\r
+        Possible Impacts:\r
+        1) New module migrated from old R9\r
+\r
+\r
+==========================================================================================\r
+EDK_3766: Non-Compatible: lgao4\r
+\r
+      Class_BuildConfiguration: Update Acpi Asl file Build rule to remove trim step.\r
+\r
+        Code Change :\r
+        1) Conf/build_rule.template\r
+\r
+        Possible Impacts:\r
+        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. \r
+\r
+\r