MdeModulePkg/ChangeLog.txt

   1 ##########################################################################################
   2 !!!!!!!!!!!!!!!!!               Notes for this ChangeLog.txt             !!!!!!!!!!!!!!!!!
   3
   4 This log file is used to record two kinds of important information:
   5  a) "Non-Compatible Changes": all non-compatible changes should be recorded. These info
   6     will help the package user to merge this package; and some non-compatible changes
   7     can also be added into release notes as news features when we release this package.
   8     Normally Non-Compatible Changes contains the following types:
   9       1) Package's external services were changed/updated
  10       2) Package's common .h file is renamed, deleted, or the file path is changed.
  11       3) The definition of package's common data structure is changed
  12       ...
  13
  14  b) "Important Compatible Changes": some important compatible changes can aslo be recorded
  15     in this file, and we can add these updating into release notes when we release this
  16     package.
  17
  18 Non-Compatible and Compatible example format:
  19 ==========================================================================================
  20 EDK_0010: Non-Compatible: owner
  21
  22           Class_HFile: PPI A of MdePkg has been removed.
  23
  24                 Code Change :
  25                 1) Removed the .h file: MdePkg\Include\Ppi\A.h
  26
  27                 Possible Impacts:
  28                 1) All modules that used this PPI A should be updated.
  29
  30 ==========================================================================================
  31 EDK_0000: Compatible: owner
  32
  33           Class_BuildTool: with the EDK_0000 build.exe, the build performance is enhanced great.
  34
  35                 Code Change :
  36                 1) BaseTools\Bin\Win32\build.exe
  37
  38 !!!!!!!!!!!!!!!!!!                     End of Notes                     !!!!!!!!!!!!!!!!!!
  39 ##########################################################################################
  40
  41
  42
  43
  44 ==========================================================================================
  45 EDK_3773:  Non-Compatible: qwang12
  46
  47           Class_PIEnable[0]:  Enable DXE Core to produce EFI_FIRMWARE_VOLUME2_PROTOCOL only.
  48
  49                 Code Change :
  50                 1) Modify MdeModulePkg/Core/Dxe/DxeMain.inf module to produce only
  51                    EFI_FIRMWARE_VOLUME2_PROTOCOL.       Previously, EFI_FIRMWARE_VOLUME_PROTOCOL
  52                    is produced by Dxe Core.
  53
  54                 Possible Impacts:
  55                 1) All modules that references EFI_FIRMWARE_VOLUME_PROTOCOL must be updated to use
  56                    EFI_FIRMWARE_VOLUME2_PROTOCOL.
  57                 2) All modules that references gEfiFirmwareVolumeProtocolGuid must be updated to
  58                    use gEfiFirmwareVolume2ProtocolGuid.
  59                 3) The gEfiFirmwareVolumeProtocolGuid in [Depex] section of INF file should updated.
  60                    And the package dependency should also be changed if needed due to this protocol
  61                    GUID change.
  62
  63 ==========================================================================================
  64 EDK_3871: Non-Compatible: klu2
  65
  66         Class_PIEnable[1]: Use new entry point for PeiCore defined in PI specification.
  67
  68         Code Change:
  69         1) PeiMain module use PeiCoreEntryPoint library class but *not* original OldPeiCoreEntryPoint.
  70         2) The memory service in PeiMain module get CAR base and size from parameter of PeiCore's
  71            Entry point directly but *not* computed from stack's base.
  72
  73         Possible Impacts:
  74         1) Platform should select MdePkg/Library/PeiCoreEntryPoint/PeiCoreEntryPoint.inf for
  75            PeiMain module.
  76         2) The SecCore module should provide parameters for new entry point defined in
  77            MdePkg\Include\Library\PeiCoreEntryPoint.h
  78
  79 ==========================================================================================
  80 EDK_3866:  Compatible: qhuang8
  81
  82           Class_UefiEnable[0]:  Uefi2.1 feature - Add Hardware Error Record Persistence Support
  83                 Code Change :
  84                 1) Modify MdeModulePkg/Universal/Variable/RuntimeDxe
  85                 2) Modify MdeModulePkg/Universal/Variable/EmuRuntimeDxe