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