Add in the ChangeLog.txt to detail the non-compatibile changes and other important...

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@3797 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/MdeModulePkg/ChangeLog.txt b/MdeModulePkg/ChangeLog.txt
new file mode 100644 (file)
index 0000000..35971b1
--- /dev/null
+++ b/MdeModulePkg/ChangeLog.txt
@@ -0,0 +1,61 @@
+##########################################################################################\r
+!!!!!!!!!!!!!!!!!               Notes for this ChangeLog.txt             !!!!!!!!!!!!!!!!!\r
+\r
+This log file is used to record two kinds of important information:\r
+ a) "Non-Compatible Changes": all non-compatible changes should be recorded. These info\r
+    will help the package user to merge this package; and some non-compatible changes\r
+    can also be added into release notes as news features when we release this package.\r
+    Normally Non-Compatible Changes contains the following types:\r
+      1) Package's external services were changed/updated\r
+      2) Package's common .h file is renamed, deleted, or the file path is changed.\r
+      3) The definition of package's common data structure is changed\r
+      ...\r
+\r
+ b) "Important Compatible Changes": some important compatible changes can aslo be recorded\r
+    in this file, and we can add these updating into release notes when we release this\r
+    package.\r
+\r
+Non-Compatible and Compatible example format:\r
+==========================================================================================\r
+EDK_0010: Non-Compatible: owner\r
+\r
+         Class_HFile: PPI A of MdePkg has been removed.\r
+\r
+               Code Change :\r
+               1) Removed the .h file: MdePkg\Include\Ppi\A.h\r
+\r
+               Possible Impacts:\r
+               1) All modules that used this PPI A should be updated.\r
+\r
+==========================================================================================\r
+EDK_0000: Compatible: owner\r
+\r
+         Class_BuildTool: with the EDK_0000 build.exe, the build performance is enhanced great.\r
+\r
+               Code Change :\r
+               1) BaseTools\Bin\Win32\build.exe\r
+\r
+!!!!!!!!!!!!!!!!!!                     End of Notes                     !!!!!!!!!!!!!!!!!!\r
+##########################################################################################\r
+\r
+\r
+\r
+\r
+==========================================================================================\r
+EDK_3773:  Non-Compatible: qwang12\r
+\r
+         Class_PIEnable[0]:  Enable DXE Core to produce EFI_FIRMWARE_VOLUME2_PROTOCOL only.\r
+\r
+               Code Change :\r
+               1) Modify MdeModulePkg/Core/Dxe/DxeMain.inf module to produce only\r
+                  EFI_FIRMWARE_VOLUME2_PROTOCOL.       Previously, EFI_FIRMWARE_VOLUME_PROTOCOL\r
+                  is produced by Dxe Core.\r
+\r
+               Possible Impacts:\r
+               1) All modules that references EFI_FIRMWARE_VOLUME_PROTOCOL must be updated to use\r
+                  EFI_FIRMWARE_VOLUME2_PROTOCOL.\r
+               2) All modules that references gEfiFirmwareVolumeProtocolGuid must be updated to\r
+                  use gEfiFirmwareVolume2ProtocolGuid.\r
+               3) The gEfiFirmwareVolumeProtocolGuid in [Depex] section of INF file should updated.\r
+                  And the package dependency should also be changed if needed due to this protocol\r
+                  GUID change.\r