Reviewed the code comments in the Include/Protocol directory for typos, grammar issue...
[mirror_edk2.git] / EdkShellBinPkg / ChangeLog.txt
1 ##########################################################################################
2 !!!!!!!!!!!!!!!!! Notes for this ChangeLog.txt !!!!!!!!!!!!!!!!!
3
4 This log file is used to record two kinds of important information:
5 a) "Non-Compatible Changes": all non-compatible changes should be recorded. These info
6 will help the package user to merge this package; and some non-compatible changes
7 can also be added into release notes as news features when we release this package.
8 Normally Non-Compatible Changes contains the following types:
9 1) Package's external services were changed/updated
10 2) Package's common .h file is renamed, deleted, or the file path is changed.
11 3) The definition of package's common data structure is changed
12 ...
13
14 b) "Important Compatible Changes": some important compatible changes can aslo be recorded
15 in this file, and we can add these updating into release notes when we release this
16 package.
17
18 Non-Compatible and Compatible example format:
19 ==========================================================================================
20 EDK_0010: Non-Compatible: owner
21
22 Class_HFile: PPI A of MdePkg has been removed.
23
24 Code Change :
25 1) Removed the .h file: MdePkg\Include\Ppi\A.h
26
27 Possible Impacts:
28 1) All modules that used this PPI A should be updated.
29
30 ==========================================================================================
31 EDK_0000: Compatible: owner
32
33 Class_BuildTool: with the EDK_0000 build.exe, the build performance is enhanced great.
34
35 Code Change :
36 1) BaseTools\Bin\Win32\build.exe
37
38 !!!!!!!!!!!!!!!!!! End of Notes !!!!!!!!!!!!!!!!!!
39 ##########################################################################################
40
41 =========================================================================================
42 EDK_4227: Compatible: qhuang8
43
44 Shell Applications: Update shell binaries: built from Edk Shell release 1.03 and
45 EdkCompatibilityPkg r2246. For more details on how to build these binaries,
46 please refer to ReadMe.txt in this package.
47
48 Code Change:
49 Shell binaries under EdkShellBinPkg
50
51
52
53 =========================================================================================
54 EDK_4222: Non-Compatible: qhuang8
55
56 Shell Applications: Remove duplicate applications. There are duplicate copies in
57 this package. Remove them to avoid maintenance efforts.
58
59 Code Change:
60 1) Remove all the applications under
61 "EdkShellBinPkg\MinimumShell\ia32\Apps"
62 this directory is exactly the same as
63 EdkShellBinPkg\bin\ia32\Apps
64 2) Remove all the applications under
65 "EdkShellBinPkg\MinimumShell\x64\Apps"
66 this directory is exactly the same as
67 EdkShellBinPkg\bin\ia32\Apps
68 3) Remove all the applications under
69 "EdkShellBinPkg\MinimumShell\ia32\Apps"
70 this directory is exactly the same as
71 EdkShellBinPkg\bin\ia32\Apps
72
73
74
75 Possible Impacts:
76 1) Platform FDF files that directly refer to these applications should update the
77 locations to avoid build break.
78
79
80
81 ==========================================================================================