IntelFrameworkPkg/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 EDK_4853: Non-Compatible: qwang12
  43
  44           remove the definition of EFI_DISPATCH_OPROM_TABLE from IntelFrameworkPkg\Include\Framework\Legacy16.h
  45           as it is not defined in any Intel Framework spec.
  46
  47                 Possible Impacts:
  48                 1) Modules that may reference this structure.
  49
  50 ==========================================================================================
  51 EDK_5216: Non-Compatible: qwang12
  52
  53           PI spec defines some definitions that same name with those in Framework Specification.
  54           Change those in Framework Specifications by adding "FRAMEWORK_" prefix so that these two
  55           header file can be included in the same module (for example a thunk driver).
  56
  57           EFI_FV_ATTRIBUTES
  58           EFI_FV_GET_ATTRIBUTES
  59           EFI_FV_SET_ATTRIBUTES
  60           EFI_FV_READ_FILE
  61           EFI_FV_READ_SECTION
  62           EFI_FV_WRITE_POLICY
  63           EFI_FV_UNRELIABLE_WRITE
  64           EFI_FV_RELIABLE_WRITE
  65           EFI_FV_WRITE_FILE_DATA
  66           EFI_FV_WRITE_FILE
  67           EFI_FV_GET_NEXT_FILE
  68
  69                 Possible Impacts:
  70                 1) Modules that may reference this definitions need to be updated.