Add Change Log file for some non-backward compatible changes in ECP.

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

diff --git a/EdkCompatibilityPkg/ChangeLog.txt b/EdkCompatibilityPkg/ChangeLog.txt
new file mode 100644 (file)
index 0000000..fee46f1
--- /dev/null
+++ b/EdkCompatibilityPkg/ChangeLog.txt
@@ -0,0 +1,75 @@
+##########################################################################################\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
+EDK_r4955: Non-Compatible: qhuang8\r
+       \r
+       Class_HFile: Update the Device Type Value of MEDIA_FV_DP & MEDIA_FV_FILEPATH_DP.\r
+       The definitions in MdePkg have already been updated in r4632. This will remove the\r
+        potential compatibility issues when native EDK II modules & EDK modules built with\r
+        ECP and run with EDK II core.  \r
+\r
+       Code Change:\r
+       1) Reverse the value of MEDIA_FV_DP & MEDIA_FV_FILEPATH_DP to fix a UEFI errata. \r
+\r
+\r
+       Possible impact:\r
+       1) EDK I modules built with this update might not work with old EDK environment.        \r
+\r
+\r
+==========================================================================================\r
+EDK_r4960: Non-Compatible: qhuang8\r
+       \r
+       Class_HFile: Remove the default value 0xE0000000 of EDKII_GLUE_PciExpressBaseAddress.\r
+       It now requires platform DSC file to specify it explicitly to avoid runtime issue\r
+        if they ever uses PciExpressLib in EDK GlueLib.\r
+        Unlike other default value in GlueLib, this value might not function for all real\r
+        platforms.   \r
+\r
+       Code Change:\r
+       1) Replace 0xE0000000 to be PCD_EDKII_GLUE_PciExpressBaseAddress. \r
+\r
+       Possible impact:\r
+       1) If a platform ever uses PciExpressLib in Glue Lib. It needs to explictly specify\r
+       the value of PCD_EDKII_GLUE_PciExpressBaseAddress for their platform to function.\r
+       e.g. in EDK II DSC file to build EDK modules: \r
+               [BuildOptions]\r
+          *_*_*_CC_FLAGS = /D PCD_EDKII_GLUE_PciExpressBaseAddress=0xC0000000\r
+ \r