Update the ChangeLog.txt to record the possible non-compatible changes due to PI...
[mirror_edk2.git] / MdePkg / ChangeLog.txt
CommitLineData
1b7f7985 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
6a9d345a 38\r
39==========================================================================================\r
40EDK_3871: Non-Compatible: klu2\r
41 \r
42 Class_PIEnable[1]: Use new entry point for PeiCore defined in PI specification.\r
43 \r
44 Code Change:\r
45 1) Remove the definition and library instance for OldPeiCoreEntryPoinLib\r
46 \r
47 Possible Impacts:\r
48 1) Platform should select MdePkg/Library/PeiCoreEntryPoint/PeiCoreEntryPoint.inf for \r
49 PeiMain module.\r
50 2) The SecCore module should provide parameters for new entry point defined in \r
51 MdePkg\Include\Library\PeiCoreEntryPoint.h\r
52\r
1b7f7985 53!!!!!!!!!!!!!!!!!! End of Notes !!!!!!!!!!!!!!!!!!\r
54##########################################################################################\r
55\r
56\r
57\r