From 1b7f7985bdea35070e889de439e7bdc2a4539357 Mon Sep 17 00:00:00 2001 From: zliu3 Date: Thu, 13 Sep 2007 06:38:20 +0000 Subject: [PATCH] Add the "ChangeLog.txt" to record packages' all non-compatible changes and important compatible changes. git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@3830 6f19259b-4bc3-4df7-8a09-765794883524 --- BaseTools/ChangeLog.txt | 42 +++++++++++++++++++++++++++ IntelFrameworkModulePkg/ChangeLog.txt | 42 +++++++++++++++++++++++++++ IntelFrameworkPkg/ChangeLog.txt | 42 +++++++++++++++++++++++++++ MdePkg/ChangeLog.txt | 42 +++++++++++++++++++++++++++ 4 files changed, 168 insertions(+) create mode 100644 BaseTools/ChangeLog.txt create mode 100644 IntelFrameworkModulePkg/ChangeLog.txt create mode 100644 IntelFrameworkPkg/ChangeLog.txt create mode 100644 MdePkg/ChangeLog.txt diff --git a/BaseTools/ChangeLog.txt b/BaseTools/ChangeLog.txt new file mode 100644 index 0000000000..2cba62a250 --- /dev/null +++ b/BaseTools/ChangeLog.txt @@ -0,0 +1,42 @@ +########################################################################################## +!!!!!!!!!!!!!!!!! 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 !!!!!!!!!!!!!!!!!! +########################################################################################## + + + diff --git a/IntelFrameworkModulePkg/ChangeLog.txt b/IntelFrameworkModulePkg/ChangeLog.txt new file mode 100644 index 0000000000..2cba62a250 --- /dev/null +++ b/IntelFrameworkModulePkg/ChangeLog.txt @@ -0,0 +1,42 @@ +########################################################################################## +!!!!!!!!!!!!!!!!! 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 !!!!!!!!!!!!!!!!!! +########################################################################################## + + + diff --git a/IntelFrameworkPkg/ChangeLog.txt b/IntelFrameworkPkg/ChangeLog.txt new file mode 100644 index 0000000000..2cba62a250 --- /dev/null +++ b/IntelFrameworkPkg/ChangeLog.txt @@ -0,0 +1,42 @@ +########################################################################################## +!!!!!!!!!!!!!!!!! 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 !!!!!!!!!!!!!!!!!! +########################################################################################## + + + diff --git a/MdePkg/ChangeLog.txt b/MdePkg/ChangeLog.txt new file mode 100644 index 0000000000..2cba62a250 --- /dev/null +++ b/MdePkg/ChangeLog.txt @@ -0,0 +1,42 @@ +########################################################################################## +!!!!!!!!!!!!!!!!! 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 !!!!!!!!!!!!!!!!!! +########################################################################################## + + + -- 2.39.2