tyler.durden
/
audk
mirror of https://github.com/acidanthera/audk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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
This commit is contained in:
qwang12 2007-09-12 03:24:49 +00:00
parent 585411e19d
commit 5182bf8ec8
1 changed files with 61 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

61
MdeModulePkg/ChangeLog.txt Normal file
View File

@ -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.