[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
        r1426 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/Autogen\r
        r1426 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/build\r
        r1426 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/Common\r
        r1426 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/CommonDataClass\r
        r1426 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/GenFds\r
        r1426 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/Workspace\r
\r
    BaseTools/Bin/Win32/GenFds.exe\r
        r1426 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/Common\r
        r1426 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/CommonDataClass\r
        r1426 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/GenFds\r
        r1426 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
        r1383 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/Trim\r
        r1383 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_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
Commit	Line	Data
07a756b9	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
	22	Class_HFile: PPI A of MdePkg has been removed.\r
	23	\r
	24	Code Change :\r
	25	1) Removed the .h file: MdePkg\Include\Ppi\A.h\r
	26	\r
	27	Possible Impacts:\r
	28	1) All modules that used this PPI A should be updated.\r
	29	\r
	30	==========================================================================================\r
	31	EDK_0000: Compatible: owner\r
	32	\r
	33	Class_BuildTool: with the EDK_0000 build.exe, the build performance is enhanced great.\r
	34	\r
	35	Code Change :\r
	36	1) BaseTools\Bin\Win32\build.exe\r
	37	\r
	38	!!!!!!!!!!!!!!!!!! End of Notes !!!!!!!!!!!!!!!!!!\r
183eb3e6	39	\r
	40	##########################################################################################\r
	41	\r
07a756b9	42	##########################################################################################\r
183eb3e6	43	########## Revision number of tools source code ##########\r
183eb3e6	44	BaseTools/Bin/Win32/build.exe\r
6160c628	45	r1426 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/Autogen\r
	46	r1426 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/build\r
	47	r1426 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/Common\r
	48	r1426 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/CommonDataClass\r
	49	r1426 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/GenFds\r
	50	r1426 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/Workspace\r
183eb3e6	51	\r
183eb3e6	52	BaseTools/Bin/Win32/GenFds.exe\r
6160c628	53	r1426 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/Common\r
	54	r1426 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/CommonDataClass\r
	55	r1426 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/GenFds\r
	56	r1426 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/Workspace\r
eba88b79	57	\r
eba88b79	58	BaseTools/Bin/Win32/GenDepex.exe\r
354aa8a2	59	r1383 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/AutoGen\r
354aa8a2	60	r1383 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/Common\r
183eb3e6	61	\r
183eb3e6	62	BaseTools/Bin/Win32/Trim.exe\r
354aa8a2	63	r1383 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/Trim\r
354aa8a2	64	r1383 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/Common\r
183eb3e6	65	\r
	66	BaseTools/Bin/Win32/MigrationMsa2Inf.exe\r
	67	r843 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/MigrationMsa2Inf\r
94dfb890	68	r843 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/Common\r
183eb3e6	69	\r
	70	BaseTools/Bin/Win32/TargetTool.exe\r
	71	r843 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/TargetTool\r
94dfb890	72	r843 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/Common\r
183eb3e6	73	\r
1db5dde1	74	BaseTools/Bin/Win32/Spd2Dec.exe\r
	75	r777 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/spd2dec\r
	76	\r
	77	BaseTools/Bin/Win32/Fpd2Dsc.exe\r
	78	r767 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/fpd2dsc\r
183eb3e6	79	\r
189b65e4	80	==========================================================================================\r
6160c628	81	basetools_7159: Non-Compatible: jwang36\r
	82	\r
	83	Class_BuildTool:\r
	84	1) Re-fine and fully test the mechanism of getting over the long command\r
	85	line limitation\r
	86	2) Change the -s option of build from "SpawnMode" to be "SilentMode"\r
	87	3) Change the prototype of PeiCoreEntryPoint in AutoGen-ed code\r
	88	4) Remove CalcDeps module since it's no longer needed.\r
	89	5) Remove "-k", "-g" and "-l" switches from build\r
	90	6) Remove MULTIPLE_THREAD in target.template. Use MAX_CONCURRENT_THREAD_NUMBER\r
	91	to get the same functionality.\r
	92	\r
	93	Code Change :\r
	94	1) /trunk/edk2/BaseTools/Bin/Win32/build.exe\r
	95	1) /trunk/edk2/BaseTools/Bin/Win32/GenFds.exe\r
	96	\r
	97	Possible Impacts:\r
	98	1) The local version build_rule.txt must be updated with changes in build_rule.template\r
	99	2) Use "build -s" to pass "-s" switch to "make" tool to do silent "make".\r
	100	To suppress all message from stdout, use "build -q" instead.\r
	101	3) To get over the long command line limitation, use "@$(<FILE_TYPE>S_LIST)"\r
	102	in the place of ${src} for those commands encountering such kind of\r
	103	problem.\r
	104	\r
189b65e4	105	basetools_7009: Non-Compatible: jwang36\r
	106	\r
	107	Class_BuildTool:\r
	108	1) Search value of Guid/Protocol/PPI in inf file only in the same category in dec file.\r
	109	2) Pass all files in a module's directory to StrGather for R8 modules.\r
	110	\r
	111	Code Change :\r
	112	1) /trunk/edk2/BaseTools/Bin/Win32/build.exe\r
	113	\r
	114	Possible Impacts:\r
	115	1) Those inf files in which the PPI/Protocol/Guid are put in incorrect\r
	116	section will encounter build break.\r
	117	\r
214099c7	118	==========================================================================================\r
	119	EDK_6930: Non-Compatible: jwang36\r
	120	\r
	121	Class_BuildTool:\r
	122	1) Separate the AutoGen code for PCDs between module and its library instances.\r
	123	Only macros for module's PCDs will be put in AutoGen.h. Others will be put\r
	124	in AutoGen.c. This is intended to catch missed PCDs in inf file more easily.\r
	125	2) For better compatibile between C standards or C compiler, add type cast for\r
	126	PCD constants in AutoGen.h according to the PCD datum type.\r
	127	3) Add incremental generation capability for FV in GenFds tool.\r
	128	\r
	129	Code Change :\r
	130	1) /trunk/edk2/BaseTools/Bin/Win32/build.exe\r
	131	2) /trunk/edk2/BaseTools/Bin/Win32/GenFds.exe\r
	132	\r
	133	Possible Impacts:\r
	134	1) If there're PCDs used in a module but not declared in the module's inf file,\r
	135	and occasionally they are declared in the library instances, there must be\r
	136	a build break. Adding necessary PCDs declarations in the module's inf file\r
	137	will solve it.\r
	138	\r
354aa8a2	139	==========================================================================================\r
	140	EDK_6828: Compatible: jwang36\r
	141	\r
	142	Class_BuildTool:\r
	143	1) Add a feature to allow override tools option via "==" in metafile.\r
	144	2) Remove the AutoGen.c generation for R8 module without unicode file.\r
	145	\r
	146	\r
	147	Code Change :\r
	148	1) /trunk/edk2/BaseTools/Bin/Win32/build.exe\r
	149	\r
	150	==========================================================================================\r
	151	EDK_6772: Non-Compatible: jwang36\r
	152	\r
	153	Class_BuildTool:\r
	154	1) Add /D$(MODULE_ENTRY_POINT)=$(ARCH_ENTRY_POINT) in EBC_CC_FLAGS to ensure\r
	155	correct R8's module entry point for EBC arch.\r
	156	\r
	157	Code Change :\r
	158	1) /trunk/edk2/BaseTools/Conf/tools_def.template\r
	159	\r
	160	Possible Impacts:\r
	161	The local version of tools_def.txt must be updated with the change in\r
	162	tools_def.template.\r
	163	\r
	164	==========================================================================================\r
	165	EDK_6762: Non-Compatible: lgao4\r
	166	\r
	167	Class_BuildTool:\r
	168	1) Declare entry point, constructor into AutoGen.h\r
	169	2) Create <ModuleName>StrDefs.h to contain uni code string ID.\r
	170	\r
	171	\r
	172	Code Change :\r
	173	1) /trunk/edk2/BaseTools/Bin/Win32/build.exe\r
	174	2) /trunk/edk2/BaseTools/Conf/tools_def.template\r
	175	\r
	176	Possible Impacts:\r
	177	The local version of tools_def.txt must be updated with change in\r
	178	tools_def.tempalte.\r
	179	\r
	180	==========================================================================================\r
	181	EDK_6671: Compatible: qwang12\r
	182	\r
	183	Class_BuildTool:\r
	184	1) StrGather (Build.exe) in compatible mode add a Framework Package Header\r
	185