Add PI incompatible change into ChangeLog.txt for MdePkg and MdeModulePkg

[mirror_edk2.git] / MdePkg / ChangeLog.txt

##########################################################################################\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
\r
==========================================================================================\r
EDK_3871: Non-Compatible: klu2\r
	\r
	Class_PIEnable[1]: Use new entry point for PeiCore defined in PI specification.\r
	\r
	Code Change:\r
	1) Remove the definition and library instance for OldPeiCoreEntryPoinLib\r
	\r
	Possible Impacts:\r
	1) Platform should select MdePkg/Library/PeiCoreEntryPoint/PeiCoreEntryPoint.inf for \r
	   PeiMain module.\r
	2) The SecCore module should provide parameters for new entry point defined in \r
	   MdePkg\Include\Library\PeiCoreEntryPoint.h\r
\r
!!!!!!!!!!!!!!!!!!                     End of Notes                     !!!!!!!!!!!!!!!!!!\r
##########################################################################################\r
\r
\r
\r