Update the build instructions and change log:
[mirror_edk2.git] / EdkShellBinPkg / ChangeLog.txt
CommitLineData
a72eca84 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
39##########################################################################################\r
40\r
abe7b4c6 41=========================================================================================\r
42EDK_4227: Compatible: qhuang8\r
43 \r
44 Shell Applications: Update shell binaries: built from Edk Shell release 1.03 and \r
45 EdkCompatibilityPkg r2246. For more details on how to build these binaries,\r
46 please refer to ReadMe.txt in this package.\r
47 \r
48 Code Change:\r
49 Shell binaries under EdkShellBinPkg\r
50 \r
51 \r
52\r
53=========================================================================================\r
a72eca84 54EDK_4222: Non-Compatible: qhuang8\r
55 \r
56 Shell Applications: Remove duplicate applications. There are duplicate copies in\r
57 this package. Remove them to avoid maintenance efforts.\r
58 \r
59 Code Change:\r
60 1) Remove all the applications under\r
61 "EdkShellBinPkg\MinimumShell\ia32\Apps"\r
62 this directory is exactly the same as\r
63 EdkShellBinPkg\bin\ia32\Apps\r
64 2) Remove all the applications under\r
65 "EdkShellBinPkg\MinimumShell\x64\Apps"\r
66 this directory is exactly the same as\r
67 EdkShellBinPkg\bin\ia32\Apps \r
68 3) Remove all the applications under\r
69 "EdkShellBinPkg\MinimumShell\ia32\Apps"\r
70 this directory is exactly the same as\r
71 EdkShellBinPkg\bin\ia32\Apps\r
72 \r
73\r
74 \r
75 Possible Impacts:\r
abe7b4c6 76 1) Platform FDF files that directly refer to these applications should update the\r
77 locations to avoid build break.\r
a72eca84 78\r
79\r
80\r
81==========================================================================================\r