Add in the ChangeLog.txt to detail the non-compatibile changes and other important...
[mirror_edk2.git] / MdeModulePkg / ChangeLog.txt
CommitLineData
5182bf8e 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
41\r
42\r
43\r
44==========================================================================================\r
45EDK_3773: Non-Compatible: qwang12\r
46\r
47 Class_PIEnable[0]: Enable DXE Core to produce EFI_FIRMWARE_VOLUME2_PROTOCOL only.\r
48\r
49 Code Change :\r
50 1) Modify MdeModulePkg/Core/Dxe/DxeMain.inf module to produce only\r
51 EFI_FIRMWARE_VOLUME2_PROTOCOL. Previously, EFI_FIRMWARE_VOLUME_PROTOCOL\r
52 is produced by Dxe Core.\r
53\r
54 Possible Impacts:\r
55 1) All modules that references EFI_FIRMWARE_VOLUME_PROTOCOL must be updated to use\r
56 EFI_FIRMWARE_VOLUME2_PROTOCOL.\r
57 2) All modules that references gEfiFirmwareVolumeProtocolGuid must be updated to\r
58 use gEfiFirmwareVolume2ProtocolGuid.\r
59 3) The gEfiFirmwareVolumeProtocolGuid in [Depex] section of INF file should updated.\r
60 And the package dependency should also be changed if needed due to this protocol\r
61 GUID change.\r