update the comments on Event
[edk2.git] / IntelFrameworkModulePkg / ChangeLog.txt
blob8d9ac806c11d55daa2c0a6605f7bbe6724cfd111
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
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
18 Non-Compatible and Compatible example format:\r
19 ==========================================================================================\r
20 EDK_0010: Non-Compatible: owner\r
22           Class_HFile: PPI A of MdePkg has been removed.\r
24                 Code Change :\r
25                 1) Removed the .h file: MdePkg\Include\Ppi\A.h\r
27                 Possible Impacts:\r
28                 1) All modules that used this PPI A should be updated.\r
30 ==========================================================================================\r
31 EDK_0000: Compatible: owner\r
33           Class_BuildTool: with the EDK_0000 build.exe, the build performance is enhanced great.\r
35                 Code Change :\r
36                 1) BaseTools\Bin\Win32\build.exe\r
38 !!!!!!!!!!!!!!!!!!                     End of Notes                     !!!!!!!!!!!!!!!!!!\r
39 ##########################################################################################\r
41 ==========================================================================================\r
42 EDK_3896-3898: Compatible: qhuang8\r
44            Class_UefiEnable[0]: Uefi feature -Add component name 2 protocol support for\r
45                                 all drivers that support component name protocol\r
46         \r
48     Code Change :\r
49     1) Update IntelFrameworkModulePkg/Bus/Isa/* \r
50     2) Update IntelFrameworkModulePkg/Bus/Pci/*\r
51     3) Update IntelFrameworkModulePkg/Universal/Console/VgaClassDxe/*\r
53     possible impact:\r
54     1) To produce the component name 2 protocol, platform DSC file needs to set feature\r
55        flag 'PcdComponentName2Disable' to 'FALSE'\r
57 ==========================================================================================\r
58 EDK_4776: Compatible: qwang12\r
60 Remove the following modules.\r
62   IntelFrameworkModulePkg/Universal/HiiDataBaseDxe/HiiDatabase.inf\r
63   IntelFrameworkModulePkg/Universal/SetupBrowserDxe/SetupBrowser.inf\r
64   IntelFrameworkModulePkg/Universal/DriverSampleDxe/DriverSampleDxe.inf\r