]> git.proxmox.com Git - mirror_edk2.git/blame - BaseTools/ChangeLog.txt
sync comments, fix function header, rename variable name to follow coding style.
[mirror_edk2.git] / BaseTools / ChangeLog.txt
CommitLineData
07a756b9 1##########################################################################################\r
2!!!!!!!!!!!!!!!!! Notes for this ChangeLog.txt !!!!!!!!!!!!!!!!!\r
3\r
4This 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
18Non-Compatible and Compatible example format:\r
19==========================================================================================\r
20EDK_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
31EDK_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
44 BaseTools/Bin/Win32/build.exe\r
eba88b79 45 r1070 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/Autogen\r
46 r1070 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/build\r
47 r1070 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/Common\r
48 r1070 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/CommonDataClass\r
49 r1070 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/GenFds\r
183eb3e6 50\r
51 BaseTools/Bin/Win32/GenFds.exe\r
eba88b79 52 r1070 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/Common\r
53 r1070 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/CommonDataClass\r
54 r1070 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/GenFds\r
55\r
56 BaseTools/Bin/Win32/GenDepex.exe\r
57 r1070 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/AutoGen\r
58 r1070 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/Common\r
183eb3e6 59\r
60 BaseTools/Bin/Win32/Trim.exe\r
eba88b79 61 r1070 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/Trim\r
62 r1070 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/Common\r
183eb3e6 63\r
64 BaseTools/Bin/Win32/MigrationMsa2Inf.exe\r
65 r843 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/MigrationMsa2Inf\r
94dfb890 66 r843 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/Common\r
183eb3e6 67\r
68 BaseTools/Bin/Win32/TargetTool.exe\r
69 r843 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/TargetTool\r
94dfb890 70 r843 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/Common\r
183eb3e6 71\r
1db5dde1 72 BaseTools/Bin/Win32/Spd2Dec.exe\r
73 r777 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/spd2dec\r
74\r
75 BaseTools/Bin/Win32/Fpd2Dsc.exe\r
76 r767 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/fpd2dsc\r
183eb3e6 77\r
d28746d2 78==========================================================================================\r
eba88b79 79EDK_4859: Non-Compatible: jwang36\r
80\r
81 Class_BuildTool:\r
82 1) Changed VfrCompile.exe to be UEFI HII compatible\r
83 2) Improved R8 module build\r
84 3) Added binary file build \r
85 4) Removed "extern int __make_me_compile_correctly" in AutoGen code for \r
86 R9 modules, but kept for R8 modules\r
87 5) Enfored more error check and introduced a optimization for GenDepex\r
88 6) Added BUILD_RULE_CONF in target.txt to specify build rules file\r
89 7) Rebuilt all Python tools with Python2.5.2\r
90 \r
91 Code Change :\r
92 1) build.exe\r
93 2) VfrCompile.exe\r
94 3) GenFds.exe\r
95 4) GenDepex.exe\r
96 5) target.template\r
97\r
98\r
99 Possible Impacts:\r
100 1) All EFI code needs to be UEFI HII compatible.\r
101 2) Conf/target.txt needs to be replaced by new target.template\r
102\r
103==========================================================================================\r
d28746d2 104EDK_4251: Non-Compatible: jwang36\r
105\r
106 Class_BuildTool:\r
107 1) Changed MYTOOLS to use Visual Studio Team Suite for IA32 and X64. IPF is still use WINDKK.\r
108 2) Re-generated build.exe and GenFds.exe to incorporate new changes of build tools\r
109 3) Enabled multi-thread build mode by default (can be disabled by using "-n 0" option or changing \r
110 MULTIPLE_THREAD in target.txt to Disabled)\r
111 4) Fixed an incorrect command (no leading tab/space) generated in top level Makefile.\r
112 \r
113 Code Change :\r
114 1) BaseTools/Bin/Win32/GenFds.exe\r
115 2) BaseTools/Bin/Win32/build.exe\r
116 3) BaseTools/Conf/target.template\r
117 4) BaseTools/Conf/tools_def.template\r
118\r
119 Possible Impacts:\r
120 1) Install Visual Studio 2005 Team Suite Edition.\r
121\r
183eb3e6 122==========================================================================================\r
123EDK_4190: Non-Compatible: jwang36\r
124\r
125 Class_BuildTool:\r
126 1) Added support of using PCD default value from DEC/INF file if one\r
127 PCD is declared in INF file but not found in DSC file.\r
128 2) Added support of breaking build if no library instance is found for\r
129 a library class.\r
130 \r
131 Code Change :\r
132 1) BaseTools/Bin/Win32/build.exe\r
d28746d2 133 2) BaseTools/Bin/Win32/GenFds.exe\r
183eb3e6 134\r
135 Possible Impacts:\r
136 1) All packages/platforms/modules, which have wrong library classes\r
137 declared or have no library instance for some library classes, must be\r
138 changed to make sure each library class declared in INF file has\r
139 corresponding library instance.\r
07a756b9 140\r
141==========================================================================================\r
142EDK_4096: Non-Compatible: jwang36\r
143\r
144 Class_BuildTool:\r
145 1) Removed the calling of vsvars32.bat in edksetup.bat, unless\r
146 "--nt32" switch is used.\r
147 2) Added MAKE command in tools_def.txt. This is used to locate where\r
148 the nmake.exe or make.exe is because it will not be in PATH any more.\r
149 3) Removed the calling of vsvars32.bat in toolsetup.bat.\r
150 4) Solved the hang issue of build.exe when error occurred or Ctrl+C is\r
151 pressed.\r
152 5) Passed "-v/-d/-q" command line option to GenFds.exe in makefile if\r
153 it's used by build.exe.\r
154 \r
155 Code Change :\r
156 1) BaseTools/Bin/Win32/build.exe\r
157 2) BaseTools/Bin/Win32/GenFds.exe\r
158 3) BaseTools/Conf/tools_def.template\r
159 4) BaseTools/toolsetup.bat\r
160 5) edksetup.bat\r
161\r
162 Possible Impacts:\r
163 1) Nt32Pkg build needs to run vsvars32.bat before edksetup.bat or run\r
164 edksetup.bat with "--nt32" option, like\r
165\r
166 edksetup.bat --nt32 newbuild\r
167\r
168 2) $(WORKSPACE)/Conf/tools_def.txt must be deleted before running\r
169 edksetup.bat because of new tools_def.template. Otherwise the\r
170 build.exe cannot find the nmake.exe to call.\r
171\r
172==========================================================================================\r
173EDK_3947: Compatible: jwang36\r
174\r
175 Class_BuildTool:\r
176 1) Improved spawn mode (multi-thread) build performance (build -s)\r
177 2) Changed the error/debug/warning message format\r
178 3) Added "--log" command line option to support storing log in file\r
179 \r
180 Code Change :\r
181 1) BaseTools/Bin/Win32/build.exe\r
182\r
183\r
184==========================================================================================\r
185EDK_3936: Compatible: klu2\r
186\r
187 Class_BuildTool:\r
188 1) The first parameter of PEIM's entry point in autogen.c has been changed to \r
189 EFI_PEI_FILE_HANDLE\r
190 \r
191 Code Change :\r
192 1) BaseTools/Bin/Win32/build.exe\r
193\r
194==========================================================================================\r
195EDK_3926: Compatible: jlin16\r
196\r
197 Class_BuildTool:\r
198 1) Added support of Capsule generation from FDF file.\r
199 \r
200 Code Change :\r
201 1) BaseTools/Bin/Win32/build.exe\r
202 2) BaseTools/Bin/Win32/GenFds.exe\r
203\r
204 Possible Impacts:\r
205 1) To generate capsule, insert [Capsule] section after [FV] sections and specifying\r
206 what FV will be put into capsule, For example:\r
207 [Capsule.Fob]\r
208 CAPSULE_GUID = 3B6686BD-0D76-4030-B70E-B5519E2FC5A0\r
209 CAPSULE_FLAG = PersistAcrossReset\r
210 FV = BiosUpdate\r
211\r
212==========================================================================================\r
213EDK_3911: Compatible: jlin16\r
214\r
215 Class_BuildTool:\r
216 1) Added support of Apriori file generation from FDF file.\r
217 2) Added support of INF that describes binary files to put binary into FV.\r
218 3) Fixed single FV/FD generation error when specifying -i/-r option in GenFds.\r
219 \r
220 \r
221 Code Change :\r
222 1) BaseTools/Bin/Win32/build.exe\r
223 2) BaseTools/Bin/Win32/GenFds.exe\r
224\r
225 Possible Impacts:\r
226 1) To generate Apriori file in FV, insert APRIORI statement just before the INF or\r
227 FILE statement list of the FV, For example:\r
228 APRIORI PEI {\r
229 INF MdeModulePkg/Universal/PCD/Pei/Pcd.inf\r
230 FILE PEIM = B7A5041A-78BA-49e3-B73B-54C757811FB6 {\r
231 SECTION PE32 = MyBinPkg\bin\ia32\PeimAfterPcd.efi\r
232 }\r
233 INF IntelFrameworkModulePkg/Universal/StatusCode/Pei/PeiStatusCode.inf\r
234 }\r
235 2) To add binary file described by INF file into FV, only insert the INF statement\r
236 into the INF statements list of that FV, like this:\r
237 \r
238 INF RuleOverride=Test MdeModulePkg/Logo/Logo.inf\r
239 \r
240 Specifying how to process the binary file by defining corresponding Rule like this:\r
241 [Rule.Common.Base.Test]\r
242 FILE FREEFORM = $(NAMED_GUID) {\r
243 COMPRESS PI_STD {\r
244 GUIDED {\r
245 RAW BIN |.bmp \r
246 }\r
247 }\r
248 }\r
249\r
250==========================================================================================\r
251EDK_3832: Non-Compatible: jwang36\r
252\r
253 Class_BuildTool:\r
254 1) Added support of MACRO in tools_def.txt\r
255 2) Merged PATH and NAME attributes in tools_def.txt\r
256 3) Changed DPATH attribute to DLL in tools_def.txt\r
257 4) Removed SPATH attribute in tools_def.txt\r
258 5) Added support for library instance without library class\r
259 6) Fixed the issue in Trim tool which zero file will be generated if the trimmed \r
260 file has not line directive\r
261 \r
262 Code Change :\r
263 1) BaseTools/Bin/Win32/build.exe\r
264 2) BaseTools/Bin/Win32/GenFds.exe\r
265 3) BaseTools/Bin/Win32/Trim.exe\r
266 4) BaseTools/Conf/tools_def.template\r
267\r
268 Possible Impacts:\r
269 1) All platforms and modules build\r
270\r
271==========================================================================================\r
272EDK_3801: Compatible: jwang36\r
273\r
274 Class_BuildConfiguration: Added makefile as dependency for "Dynamic-Library-File" to \r
275 solve the incremental build issue occurred when there's library changes\r
276\r
277 Code Change :\r
278 1) BaseTools/Conf/build_rule.template\r
279\r
280==========================================================================================\r
281EDK_3800: Compatible: lgao4\r
282\r
283 Class_BuildTool: Update EfiRom tool to fix checksum and PCI3.0 data structure\r
284\r
285 Code Change :\r
286 1) BaseTools/Bin/Win32/EfiRom.exe\r
287\r
288==========================================================================================\r
289EDK_3795: Compatible: htao\r
290\r
291 Class_BuildTool: GenVtf tool open/write file with "r+b"/"w+b" attribute, but this cause\r
292 the RO attribute of the file changed. Fix this issue by changing \r
293 "r+b"/"w+b" to "rb"/"wb".\r
294\r
295 Code Change :\r
296 1) BaseTools/Bin/Win32/GenVtf.exe\r
297\r
298==========================================================================================\r
299EDK_3791: Compatible: jlin16\r
300\r
301 Class_BuildTool:\r
302 1) use '#' to indicate flash generation progress.\r
303 2) use -v to switch on detail output messages.\r
304\r
305 Code Change :\r
306 1) BaseTools/Bin/Win32/GenFds.exe\r
307\r
308==========================================================================================\r
309EDK_3789: Non-Compatible: lgao4\r
310\r
311 Class_BuildTool: support new Rules format and PCD format defined in FDF file\r
312\r
313 Code Change :\r
314 1) BaseTools/Bin/Win32/build.exe\r
315 2) BaseTools/Bin/Win32/GenFds.exe\r
316\r
317 Possible Impacts:\r
318 1) All platform's FDF file, if any, must be changed to new format.\r
319 a) PCD format is changed from old PcdName to new PcdTokenSpaceGuid.PcdName, \r
320 for example PcdWinNtFdBaseAddress in old FDF file will be replaced \r
321 by gEfiNt32PkgTokenSpaceGuid.PcdWinNtFdBaseAddres.\r
322 b) Rule format adds binary file type and file postfix name support, \r
323 and doesn't require the full file path. Examples for Peim and AcpiTable module:\r
324 Old Peim Rule:\r
325 [Rule.Common.PEIM]\r
326 FILE PEIM = $(NAMED_GUID) {\r
327 PEI_DEPEX Optional $(INF_OUTPUT)/$(MODULE_NAME).Depex\r
328 PE32 $(INF_OUTPUT)/$(MODULE_NAME).efi\r
329 UI Optional $(MODULE_NAME)\r
330 VERSION Optional BUILD_NUM=$(BUILD_NUMBER) $(INF_VERSION)\r
331 }\r
332 New Peim Rule:\r
333 [Rule.Common.PEIM]\r
334 FILE PEIM = $(NAMED_GUID) {\r
335 PEI_DEPEX PEI_DEPEX Optional |.Depex\r
336 PE32 PE32 |.efi\r
337 UI STRING="$(MODULE_NAME)" Optional \r
338 VERSION STRING="$(INF_VERSION)" Optional BUILD_NUM=$(BUILD_NUMBER) \r
339 }\r
340\r
341 Old AcpiTable Rule:\r
342 [Rule.Common.DXE_DRIVER.ACPITABLE]\r
343 FILE FREEFORM = $(NAMED_GUID) {\r
344 RAW $(INF_OUTPUT)/Madt.acpi\r
345 RAW $(INF_OUTPUT)/Fadt.acpi\r
346 RAW $(INF_OUTPUT)/Facs.acpi\r
347 RAW $(INF_OUTPUT)/Spcr.acpi\r
348 RAW $(INF_OUTPUT)/Dsdt.aml\r
349 }\r
350 New AcpiTable Rule:\r
351 [Rule.Common.DXE_DRIVER.ACPITABLE]\r
352 FILE FREEFORM = $(NAMED_GUID) {\r
353 RAW ACPI |.acpi\r
354 RAW ASL |.aml\r
355 }\r
356\r
357==========================================================================================\r
358EDK_3786: Compatible: vjeff\r
359\r
360 Class_BuildConfiguration:\r
361 1) Redirect ICC_IA32_*_PATH from C:\Program Files\Microsoft Visual Studio .NET 2003\Vc7\bin \r
362 to C:\Program Files\Intel\Compiler\C++\9.1\IA32\Bin. \r
363 2) Add ICC X64 definition to enable ICC X64 build.\r
364\r
365 Code Change :\r
366 1) BaseTools/Conf/tools_def.template\r
367\r
368==========================================================================================\r
369EDK_3785: Non-Compatible: klu2\r
370\r
371 Class_BuildTool: Upgrade the format of EFI_PEIM_ENTRY_POINT to \r
372 EFI_PEIM_ENTRY_POINT2 according to PI specification.\r
373\r
374\r
375 Code Change :\r
376 1) BaseTools/Bin/Win32/build.exe\r
377\r
378 Possible Impacts:\r
379 1) All modules build\r
380\r
381\r
382==========================================================================================\r
383EDK_3780: Non-Compatible: qhuang8\r
384\r
385 Class_MigrationTool: Update the syntax of PCD section.\r
386 Update the syntax of binary INF file\r
387 The generated Extended INF file should follow Extended INF spec 0.44\r
388\r
389 Code Change :\r
390 1) BaseTools/Bin/Win32/MigrationMsa2Inf.exe\r
391\r
392 Possible Impacts:\r
393 1) New module migrated from old R9\r
394\r
395\r
396==========================================================================================\r
397EDK_3766: Non-Compatible: lgao4\r
398\r
399 Class_BuildConfiguration: Update Acpi Asl file Build rule to remove trim step.\r
400\r
401 Code Change :\r
402 1) Conf/build_rule.template\r
403\r
404 Possible Impacts:\r
405 1) Platform with ACPI module. Acpi module needs to set /EP preprocessor compiler option \r
406 for APP_FLAGS in module inf to override the default /E option defined in tools_def.txt file. \r
407\r
408\r