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