Adding the ChangeLog.txt file to this sub-project
[people/mcb30/basetools.git] / ChangeLog.txt
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
39 ##########################################################################################\r
40 \r
41 ==========================================================================================\r
42 EDK_3926: Compatible: jlin16\r
43 \r
44       Class_BuildTool:\r
45         1) Added support of Capsule generation from FDF file.\r
46  \r
47         Code Change :\r
48         1) BaseTools/Bin/Win32/build.exe\r
49         2) BaseTools/Bin/Win32/GenFds.exe\r
50 \r
51         Possible Impacts:\r
52         1) To generate capsule, insert [Capsule] section after [FV] sections and specifying\r
53         what FV will be put into capsule, For example:\r
54         [Capsule.Fob]\r
55         CAPSULE_GUID = 3B6686BD-0D76-4030-B70E-B5519E2FC5A0\r
56         CAPSULE_FLAG = PersistAcrossReset\r
57         FV = BiosUpdate\r
58 \r
59 ==========================================================================================\r
60 EDK_3911: Compatible: jlin16\r
61 \r
62       Class_BuildTool:\r
63         1) Added support of Apriori file generation from FDF file.\r
64         2) Added support of INF that describes binary files to put binary into FV.\r
65         3) Fixed single FV/FD generation error when specifying -i/-r option in GenFds.\r
66         \r
67  \r
68         Code Change :\r
69         1) BaseTools/Bin/Win32/build.exe\r
70         2) BaseTools/Bin/Win32/GenFds.exe\r
71 \r
72         Possible Impacts:\r
73         1) To generate Apriori file in FV, insert APRIORI statement just before the INF or\r
74         FILE statement list of the FV, For example:\r
75         APRIORI PEI {\r
76           INF  MdeModulePkg/Universal/PCD/Pei/Pcd.inf\r
77           FILE PEIM = B7A5041A-78BA-49e3-B73B-54C757811FB6 {\r
78                   SECTION PE32 = MyBinPkg\bin\ia32\PeimAfterPcd.efi\r
79           }\r
80           INF  IntelFrameworkModulePkg/Universal/StatusCode/Pei/PeiStatusCode.inf\r
81         }\r
82         2) To add binary file described by INF file into FV, only insert the INF statement\r
83         into the INF statements list of that FV, like this:\r
84         \r
85         INF RuleOverride=Test MdeModulePkg/Logo/Logo.inf\r
86         \r
87         Specifying how to process the binary file by defining corresponding Rule like this:\r
88         [Rule.Common.Base.Test]\r
89                FILE FREEFORM = $(NAMED_GUID) {\r
90                  COMPRESS PI_STD {\r
91                  GUIDED {\r
92                 RAW BIN |.bmp   \r
93              }\r
94                  }\r
95                }\r
96 \r
97 ==========================================================================================\r
98 EDK_3832: Non-Compatible: jwang36\r
99 \r
100       Class_BuildTool:\r
101         1) Added support of MACRO in tools_def.txt\r
102         2) Merged PATH and NAME attributes in tools_def.txt\r
103         3) Changed DPATH attribute to DLL in tools_def.txt\r
104         4) Removed SPATH attribute in tools_def.txt\r
105         5) Added support for library instance without library class\r
106         6) Fixed the issue in Trim tool which zero file will be generated if the trimmed \r
107            file has not line directive\r
108  \r
109         Code Change :\r
110         1) BaseTools/Bin/Win32/build.exe\r
111         2) BaseTools/Bin/Win32/GenFds.exe\r
112         3) BaseTools/Bin/Win32/Trim.exe\r
113         4) BaseTools/Conf/tools_def.template\r
114 \r
115         Possible Impacts:\r
116         1) All platforms and modules build\r
117 \r
118 ==========================================================================================\r
119 EDK_3801: Compatible: jwang36\r
120 \r
121       Class_BuildConfiguration: Added makefile as dependency for "Dynamic-Library-File" to \r
122         solve the incremental build issue occurred when there's library changes\r
123 \r
124         Code Change :\r
125         1) BaseTools/Conf/build_rule.template\r
126 \r
127 ==========================================================================================\r
128 EDK_3800: Compatible: lgao4\r
129 \r
130       Class_BuildTool: Update EfiRom tool to fix checksum and PCI3.0 data structure\r
131 \r
132         Code Change :\r
133         1) BaseTools/Bin/Win32/EfiRom.exe\r
134 \r
135 ==========================================================================================\r
136 EDK_3795: Compatible: htao\r
137 \r
138       Class_BuildTool: GenVtf tool open/write file with "r+b"/"w+b" attribute, but this cause\r
139                        the RO attribute of the file changed. Fix this issue by changing \r
140                        "r+b"/"w+b" to "rb"/"wb".\r
141 \r
142         Code Change :\r
143         1) BaseTools/Bin/Win32/GenVtf.exe\r
144 \r
145 ==========================================================================================\r
146 EDK_3791: Compatible: jlin16\r
147 \r
148       Class_BuildTool:\r
149         1) use '#' to indicate flash generation progress.\r
150         2) use -v to switch on detail output messages.\r
151 \r
152         Code Change :\r
153         1) BaseTools/Bin/Win32/GenFds.exe\r
154 \r
155 ==========================================================================================\r
156 EDK_3789: Non-Compatible: lgao4\r
157 \r
158       Class_BuildTool: support new Rules format and PCD format defined in FDF file\r
159 \r
160         Code Change :\r
161         1) BaseTools/Bin/Win32/build.exe\r
162         2) BaseTools/Bin/Win32/GenFds.exe\r
163 \r
164         Possible Impacts:\r
165         1) All platform's FDF file, if any, must be changed to new format.\r
166           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
167           b) Rule format adds binary file type and file postfix name support, and doesn't require the full file path. For example:\r
168           Old Peim Rule:\r
169           [Rule.Common.PEIM]\r
170           FILE PEIM = $(NAMED_GUID) {\r
171              PEI_DEPEX Optional        $(INF_OUTPUT)/$(MODULE_NAME).Depex\r
172              PE32                      $(INF_OUTPUT)/$(MODULE_NAME).efi\r
173              UI Optional               $(MODULE_NAME)\r
174              VERSION Optional          BUILD_NUM=$(BUILD_NUMBER) $(INF_VERSION)\r
175           }\r
176           New Peim Rule:\r
177           [Rule.Common.PEIM]\r
178             FILE PEIM = $(NAMED_GUID) {\r
179                PEI_DEPEX PEI_DEPEX Optional        |.Depex\r
180                PE32      PE32                      |.efi\r
181                UI       STRING="$(MODULE_NAME)" Optional         \r
182                VERSION  STRING="$(INF_VERSION)" Optional BUILD_NUM=$(BUILD_NUMBER)   \r
183             }\r
184 \r
185 ==========================================================================================\r
186 EDK_3786: Compatible: vjeff\r
187 \r
188       Class_BuildConfiguration:\r
189         1) Redirect ICC_IA32_*_PATH from C:\Program Files\Microsoft Visual Studio .NET 2003\Vc7\bin \r
190            to C:\Program Files\Intel\Compiler\C++\9.1\IA32\Bin. \r
191         2) Add ICC X64 definition to enable ICC X64 build.\r
192 \r
193         Code Change :\r
194         1) BaseTools/Conf/tools_def.template\r
195 \r
196 ==========================================================================================\r
197 EDK_3785: Non-Compatible: klu2\r
198 \r
199       Class_BuildTool: Upgrade the format of EFI_PEIM_ENTRY_POINT to \r
200                        EFI_PEIM_ENTRY_POINT2 according to PI specification.\r
201 \r
202 \r
203         Code Change :\r
204         1) BaseTools/Bin/Win32/build.exe\r
205 \r
206         Possible Impacts:\r
207         1) All modules build\r
208 \r
209 \r
210 ==========================================================================================\r
211 EDK_3780: Non-Compatible: qhuang8\r
212 \r
213       Class_MigrationTool: Update the syntax of PCD section.\r
214                            Update the syntax of binary INF file\r
215                            The generated Extended INF file should follow Extended INF spec 0.44\r
216 \r
217         Code Change :\r
218         1) BaseTools/Bin/Win32/MigrationMsa2Inf.exe\r
219 \r
220         Possible Impacts:\r
221         1) New module migrated from old R9\r
222 \r
223 \r
224 ==========================================================================================\r
225 EDK_3766: Non-Compatible: lgao4\r
226 \r
227       Class_BuildConfiguration: Update Acpi Asl file Build rule to remove trim step.\r
228 \r
229         Code Change :\r
230         1) Conf/build_rule.template\r
231 \r
232         Possible Impacts:\r
233         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
234 \r
235 \r