Update all INF, DEC and DSC file to confirm to newest INF spec 0.44, DEC spec 0.41...

[mirror_edk2.git] / BaseTools / ReadMe.txt

diff --git a/BaseTools/ReadMe.txt b/BaseTools/ReadMe.txt
index 8039b90888ce95a99e1efb8bbc682e75a4474cad..32d4fd14f3b4aa7e037da8bedf68dfc51c972a1c 100644 (file)
--- a/BaseTools/ReadMe.txt
+++ b/BaseTools/ReadMe.txt
@@ -28,12 +28,16 @@ Notes:
         cannot generate AutoGen.* files. Only "build" command can.\r
 3) build.exe in %WORKSPACE%\BaseTools\Bin\Win32 is generated from following revision of\r
    Python source code:\r
-        r620 <buildtools_project>\BaseTools\Source\Python\Autogen\r
-        r601 <buildtools_project>\BaseTools\Source\Python\build\r
-        r569 <buildtools_project>\BaseTools\Source\Python\Common\r
-        r564 <buildtools_project>\BaseTools\Source\Python\CommonDataClass\r
+        r641 <buildtools_project>\BaseTools\Source\Python\Autogen\r
+        r641 <buildtools_project>\BaseTools\Source\Python\build\r
+        r641 <buildtools_project>\BaseTools\Source\Python\Common\r
+        r641 <buildtools_project>\BaseTools\Source\Python\CommonDataClass\r
         r564 <buildtools_project>\BaseTools\Source\Python\GenFds\r
-\r
+4) GenFds.exe has is a combo of the follow python source.(This is a temporary branch)\r
+        r641 <buildtools_project>\BaseTools\Source\Python\Common\r
+        r641 <buildtools_project>\BaseTools\Source\Python\CommonDataClass\r
+        r564 <buildtools_project>\BaseTools\Source\Python\GenFds\r
+       \r
 Brief usage for Migration Tool MigrationMsa2Inf.exe:\r
 1. Command line format:\r
   MigrationMsa2Inf [options]\r
@@ -93,4 +97,27 @@ Brief usage for Migration Tool MigrationMsa2Inf.exe:
 7. Pyton Source\r
    r633 <buildtools_project>\BaseTools\Source\Python\MigrationMsa2Inf\r
 \r
-29-August-2007\r
+\r
+Brief Usage for PcdSyntax Update:\r
+Usage:\r
+  PcdSyntaxUpdate.exe <directory_name>\r
+It searches all INF, DEC and DSC file under <directory_name> and update them with the following rules:\r
+1. Update INF files to conform to INF spec 0.44: \r
+   a. Rename PCD section name: e.g. [PcdsFeatureFlag] -> [FeaturePcd]\r
+   b. Adjust PCD section item format: e.g. PcdDebugClearMemoryValue|gEfiMdePkgTokenSpaceGuid -> gEfiMdePkgTokenSpaceGuid.PcdDebugClearMemoryValue\r
+   c. Update the syntax of binary INF file (not PCD related) \r
+2. Update DEC files to confirm to DEC spec 0.36\r
+   Adjust PCD section item format: e.g. PcdWinNtPhysicalDisk|0x00001000|gEfiNt32PkgTokenSpaceGuid|VOID*|L"E:RW;245760;512"-> gEfiNt32PkgTokenSpaceGuid.PcdWinNtFlashFvRecoverySize|0x0|UINT32|0x00001011\r
+3. Update DSC files to confirm to DSC spec \r
+   a. Adjust string/array typed PCD item format: e.g. PcdWinNtMemorySizeForSecMain|gEfiNt32PkgTokenSpaceGuid|L"64!64"|12 -> gEfiNt32PkgTokenSpaceGuid.PcdWinNtMemorySizeForSecMain|L"64!64"|VOID*|12\r
+   b. Adjust non-string/array typed PCD item format: e.g. PcdWinNtBootMode|gEfiNt32PkgTokenSpaceGuid|1 -> gEfiNt32PkgTokenSpaceGuid.PcdWinNtBootMode|1\r
+   c. Update the override library class in [Components] section: e.g.\r
+   <LibraryClass> {\r
+      PcdLib|MdePkg/Library/BasePcdLibNull/BasePcdLibNull.inf\r
+   }\r
+   To \r
+   <LibraryClasses> {\r
+      PcdLib|MdePkg/Library/BasePcdLibNull/BasePcdLibNull.inf\r
+   }\r
+\r
+30-August-2007\r