Reviewed the description in the FatBinPkg .dec file.

[mirror_edk2.git] / BaseTools / ReadMe.txt

diff --git a/BaseTools/ReadMe.txt b/BaseTools/ReadMe.txt
index 8039b90888ce95a99e1efb8bbc682e75a4474cad..6ad748e78de8e7f68758f52d0db56ec9bff8291f 100644 (file)
--- a/BaseTools/ReadMe.txt
+++ b/BaseTools/ReadMe.txt
@@ -26,14 +26,9 @@ Notes:
    after you call "nmake cleanall", you have to call "build" command to rebuild platform\r
         or modules because the AutoGen.* files have been be removed. The "makefile" itself\r
         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
-        r564 <buildtools_project>\BaseTools\Source\Python\GenFds\r
-\r
+3) All .exe binary file including C and python tools are generated from:\r
+    r1623 <buildtools_project>\BaseTools\Source\Python\\r
+       \r
 Brief usage for Migration Tool MigrationMsa2Inf.exe:\r
 1. Command line format:\r
   MigrationMsa2Inf [options]\r
@@ -91,6 +86,69 @@ Brief usage for Migration Tool MigrationMsa2Inf.exe:
    f. When tool generates [LibraryClasses] section, the recommended library instances are lost. (No impact to build)\r
  \r
 7. Pyton Source\r
-   r633 <buildtools_project>\BaseTools\Source\Python\MigrationMsa2Inf\r
+   r682 <buildtools_project>\BaseTools\Source\Python\MigrationMsa2Inf\r
+\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
+Brief usage for Migration Tool Spd2Dec.exe:\r
+1. Command line format:\r
+  Spd2Dec [options] input_filename\r
+2. Input File:\r
+  A syntactically valid SPD file\r
+3. Output Files:\r
+  A DEC file whose syntax confirms to DEC spec.\r
+     \r
+4. Example:\r
+   a. Spd2Dec -o c:\work\EdkII\Nt32Pkg\Nt32.spd c:\work\EdkII\Nt32Pkg\Nt32.dec\r
+   b. Spd2Dec -a c:\work\EdkII\Nt32Pkg\Nt32.spd\r
+   Example a & b are equivalent to migrate Nt32 package SPD file from EDKII to EDKII' snytax.\r
+  \r
+6. Pyton Source\r
+   r777 <buildtools_project>\BaseTools\Source\Python\spd2Dec\r
+\r
+Brief usage for Migration Tool Fpd2Dsc.exe:\r
+1. Command line format:\r
+  Fpd2Dsc [options] input_filename\r
+2. Input File:\r
+  A syntactically valid FPD file\r
+3. Output Files:\r
+  A DSC file which syntax confirms to DSC spec.\r
+4. Prerequisite:\r
+   a. The workspace directory must be specified either by environment variable or -w option.\r
+     \r
+5. Example:\r
+   WORKSAPCE has already been set: $(WORKSPACE) = c:\work\EdkII. \r
+ \r
+   a. Fpd2Dsc -o c:\work\EdkII\Nt32Pkg\Nt32.dsc c:\work\EdkII\Nt32Pkg\Nt32.fpd\r
+   b. Fpd2Dsc -a c:\work\EdkII\Nt32Pkg\Nt32.fpd\r
+   Example a & b are equivalent to migrate Nt32 platform description file from EDKII to EDKII' snytax.\r
+  \r
+6. Known Limitations:\r
+   a. Tool does not handle Libraries Section since no related info in original FPD file. Developers need  to handle it manually in the output DSC file.\r
+   b. If MSA file which is corresponds to module guid could not be found in currect workspace, tool will dump the module guid.\r
+ \r
+7. Pyton Source\r
+   r767 <buildtools_project>\BaseTools\Source\Python\Fpd2Dsc\r
 \r
-29-August-2007\r
+27-September-2007\r