summaryrefslogtreecommitdiff
path: root/MdeModulePkg/ChangeLog.txt
diff options
context:
space:
mode:
authorqwang12 <qwang12@6f19259b-4bc3-4df7-8a09-765794883524>2007-09-12 03:24:49 +0000
committerqwang12 <qwang12@6f19259b-4bc3-4df7-8a09-765794883524>2007-09-12 03:24:49 +0000
commit5182bf8ec881c236b773091c39b53c7ae589fc1d (patch)
tree2823a4b90a116a3de71e8a78e0d957d4908dd218 /MdeModulePkg/ChangeLog.txt
parent585411e19d10d7d3b89846c37c266de254e75fc4 (diff)
downloadedk2-platforms-5182bf8ec881c236b773091c39b53c7ae589fc1d.tar.xz
Add in the ChangeLog.txt to detail the non-compatibile changes and other important changes.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@3797 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdeModulePkg/ChangeLog.txt')
-rw-r--r--MdeModulePkg/ChangeLog.txt61
1 files changed, 61 insertions, 0 deletions
diff --git a/MdeModulePkg/ChangeLog.txt b/MdeModulePkg/ChangeLog.txt
new file mode 100644
index 0000000000..35971b17fe
--- /dev/null
+++ b/MdeModulePkg/ChangeLog.txt
@@ -0,0 +1,61 @@
+##########################################################################################
+!!!!!!!!!!!!!!!!! Notes for this ChangeLog.txt !!!!!!!!!!!!!!!!!
+
+This log file is used to record two kinds of important information:
+ a) "Non-Compatible Changes": all non-compatible changes should be recorded. These info
+ will help the package user to merge this package; and some non-compatible changes
+ can also be added into release notes as news features when we release this package.
+ Normally Non-Compatible Changes contains the following types:
+ 1) Package's external services were changed/updated
+ 2) Package's common .h file is renamed, deleted, or the file path is changed.
+ 3) The definition of package's common data structure is changed
+ ...
+
+ b) "Important Compatible Changes": some important compatible changes can aslo be recorded
+ in this file, and we can add these updating into release notes when we release this
+ package.
+
+Non-Compatible and Compatible example format:
+==========================================================================================
+EDK_0010: Non-Compatible: owner
+
+ Class_HFile: PPI A of MdePkg has been removed.
+
+ Code Change :
+ 1) Removed the .h file: MdePkg\Include\Ppi\A.h
+
+ Possible Impacts:
+ 1) All modules that used this PPI A should be updated.
+
+==========================================================================================
+EDK_0000: Compatible: owner
+
+ Class_BuildTool: with the EDK_0000 build.exe, the build performance is enhanced great.
+
+ Code Change :
+ 1) BaseTools\Bin\Win32\build.exe
+
+!!!!!!!!!!!!!!!!!! End of Notes !!!!!!!!!!!!!!!!!!
+##########################################################################################
+
+
+
+
+==========================================================================================
+EDK_3773: Non-Compatible: qwang12
+
+ Class_PIEnable[0]: Enable DXE Core to produce EFI_FIRMWARE_VOLUME2_PROTOCOL only.
+
+ Code Change :
+ 1) Modify MdeModulePkg/Core/Dxe/DxeMain.inf module to produce only
+ EFI_FIRMWARE_VOLUME2_PROTOCOL. Previously, EFI_FIRMWARE_VOLUME_PROTOCOL
+ is produced by Dxe Core.
+
+ Possible Impacts:
+ 1) All modules that references EFI_FIRMWARE_VOLUME_PROTOCOL must be updated to use
+ EFI_FIRMWARE_VOLUME2_PROTOCOL.
+ 2) All modules that references gEfiFirmwareVolumeProtocolGuid must be updated to
+ use gEfiFirmwareVolume2ProtocolGuid.
+ 3) The gEfiFirmwareVolumeProtocolGuid in [Depex] section of INF file should updated.
+ And the package dependency should also be changed if needed due to this protocol
+ GUID change.