sync comments, fix function header, rename variable name to follow coding style.

[mirror_edk2.git] / MdePkg / ChangeLog.txt

diff --git a/MdePkg/ChangeLog.txt b/MdePkg/ChangeLog.txt
index d3220dbae3b239a6d223efd91c03bc308cdf9331..001c71543e7417bd0ca7e3f841e22569a58183e0 100644 (file)
--- a/MdePkg/ChangeLog.txt
+++ b/MdePkg/ChangeLog.txt
@@ -142,4 +142,67 @@ EDK_4067:  Non-Compatible: qwang12
           \r
 \r
 EDK_5835:  Non-Compatible: qwang12\r
-  Class General Definitions: Remove NULL_HANDLE. All modules that referenced NULL_HANDLE should be updated to use NULL. 
\ No newline at end of file
+  Class General Definitions: NULL_HANDLE definition is removed from UefiBaseType.h. If any modules referencs NULL_HANDLE, they should be updated to use NULL. \r
+  \r
+EDK_5869:  Non-Compatible: qhuang8\r
+  Class General Definitions: Update the macro ALIGN_VARIALBE to drop the second parameter.\r
+  \r
+               Code Change:\r
+                       The macro ALIGN_VARIABLE in base.h is changed to keep the first paramter\r
+\r
+               Possible Impacts:\r
+                       Modules using this macro, it needs to adapt to new interface.\r
+                       \r
+EDK_5939:  Non-Compatible: qwang12\r
+  Library API moved frrom HiiLib to UefiLib.\r
+  \r
+               Code Change:\r
+                       Change HiiLibGetCurrentLanguage to GetCurrentLanguage and moved it from HiiLib to UefiLib.\r
+\r
+               Possible Impacts:\r
+                       All module that reference HiiLibGetCurrentLanguage should be updated in the following step:\r
+                         0) Change HiiLibGetCurrentLanguage to GetCurrentLanguage.\r
+                               1) Add UefiLib to [LibraryClass] in INF if it is not included before.\r
+                               2) Remove HiiLib from [LibraryClass] if HiiLibGetCurrentLanguage is the only API from original HiiLib referenced by this module.\r
+                               3) Add UefiLib to [LibraryClasses.common.Module Type] for the affected module if UefiLib is not in the list.\r
+                               \r
+EDK_5989:  Non-Compatible: qwang12\r
+  Library API name changed:\r
+   In IfrSupportLib,\r
+        Rename BufToHexString to BufInReverseOrderToHexString \r
+   Rename HexStringToBuf to HexStringToBufInReverseOrder\r
+\r
+Possible Impacts:\r
+                       All module that reference BufToHexString or HexStringToBuf should be updated in the following step:\r
+                         0) Change HiiLibGetCurrentLanguage to GetCurrentLanguage.\r
+                               1) Change BufToHexString to BufInReverseOrderToHexString \r
+                         2) Change HexStringToBuf to HexStringToBufInReverseOrder\r
+\r
+EDK_6111:  Non-Compatible: qwang12\r
+  Module type Include file is not included on default.\r
+   In Protocol/PPI/GUID/Libary header file, the "#include" of the module type header file such as <Base.h>, <PiPei.h>, <PiDxe.h> and \r
+   <Uefi.h> are removed. The module (DXE driver, UEFI Driver, PEIM) should include these files if required.\r
+\r
+Possible Impacts:\r
+                       Customer's module (DXE driver, UEFI Driver, PEIM) may failed to build as module type header file such as <Base.h>, <PiPei.h>, <PiDxe.h>\r
+                       <Uefi.h> is removed from the Protocol/PPI/GUID/Libary header file. If the module can build before the update but failed after the update\r
+                       because of some undefined basic data type such as "EFI_GUID", module developer should include the module type header file accordingly.\r
+                               \r
+EDK_6131:  Non-Compatible: qwang12\r
+\r
+Base on PI spec, GetPeiServicesTablePointer in PeiServicesTablePointer library is updated to return CONST EFI_PEI_SERVICES**. This is a incompatible changes. All file that reference this must be updated.\r
+\r
+Possible Impacts:\r
+                       Customer's module that reference GetPeiServicesTablePointer in PeiServicesTablePointer library may need to updated. Otherwise\r
+                       a build break (mismatch of data type) may occur.\r
+                       \r
+EDK_6307:  Non-Compatible: qwang12\r
+\r
+Remove SafeFreePool from MemoryAllocationLib as this API's name is misleading. Its implementation only check if a pointer is NULL. If a garbage pointer is passed in, the gBS->FreePool will still ASSERT in debug build and return error code. \r
+\r
+It is recommended that module writer should keep track how a pointer is allocated and free it after use.\r
+\r
+Possible Impacts:\r
+                       Customer's module that reference SafeFreePool need to updated. Otherwise\r
+                       a build break may occur.\r
+                       \r