X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=BaseTools%2FReadMe.txt;h=0ecbb64e35d2749a8bb1fa9ade630645c85e896b;hp=fb098902daea8be0d39264fb44d6e9238264dcf8;hb=cf688318ec7cdb4e54b1dccf6938e8891b82f817;hpb=6f5554bd58d3279422ed75f570f584d02ce14282

diff --git a/BaseTools/ReadMe.txt b/BaseTools/ReadMe.txt
index fb098902da..0ecbb64e35 100644
--- a/BaseTools/ReadMe.txt
+++ b/BaseTools/ReadMe.txt
@@ -21,19 +21,24 @@ BaseTools Simple Usage:
    *.inf file is
 
 Notes:
-1) Only *.efi files can be generated. Flash image cannot be generated at present.
-2) Only "clean" and "cleanall" build target are supported, in both top level 
-   makefile and module's makefile. 
-3) Not all tool chains and target architectures are tested. Due to both tools 
-   and source code limitations, ther must be bugs in it. Please report any issue 
-	 ASAP so we can fix it soon.
-4) The tree structure generated by build tools is similar to Ant build system.
-5) Makefile can be called directly by nmake for both top level platform and module. But
+1) The tree structure generated by build tools is similar to Ant build system.
+2) Makefile can be called directly by nmake for both top level platform and module. But
    after you call "nmake cleanall", you have to call "build" command to rebuild platform
 	 or modules because the AutoGen.* files have been be removed. The "makefile" itself
 	 cannot generate AutoGen.* files. Only "build" command can.
-
-
+3) build.exe in %WORKSPACE%\BaseTools\Bin\Win32 is generated from following revision of
+   Python source code:
+        r658 <buildtools_project>\BaseTools\Source\Python\Autogen
+        r658 <buildtools_project>\BaseTools\Source\Python\build
+        r658 <buildtools_project>\BaseTools\Source\Python\Common
+        r658 <buildtools_project>\BaseTools\Source\Python\CommonDataClass
+        r564 <buildtools_project>\BaseTools\Source\Python\GenFds
+        r576 <buildtools_project>\BaseTools\Source\Python\GenFds\FfsInfStatement.py
+4) GenFds.exe has is a combo of the follow python source.(This is a temporary branch)
+        r641 <buildtools_project>\BaseTools\Source\Python\Common
+        r641 <buildtools_project>\BaseTools\Source\Python\CommonDataClass
+        r564 <buildtools_project>\BaseTools\Source\Python\GenFds
+	
 Brief usage for Migration Tool MigrationMsa2Inf.exe:
 1. Command line format:
   MigrationMsa2Inf [options]
@@ -90,6 +95,30 @@ Brief usage for Migration Tool MigrationMsa2Inf.exe:
    e. When tool generates [Sources] section, the modifiers for source files are lost. (Need to add proper tool chain, etc)
    f. When tool generates [LibraryClasses] section, the recommended library instances are lost. (No impact to build)
  
+7. Pyton Source
+   r682 <buildtools_project>\BaseTools\Source\Python\MigrationMsa2Inf
+
+
+Brief Usage for PcdSyntax Update:
+Usage:
+  PcdSyntaxUpdate.exe <directory_name>
+It searches all INF, DEC and DSC file under <directory_name> and update them with the following rules:
+1. Update INF files to conform to INF spec 0.44: 
+   a. Rename PCD section name: e.g. [PcdsFeatureFlag] -> [FeaturePcd]
+   b. Adjust PCD section item format: e.g. PcdDebugClearMemoryValue|gEfiMdePkgTokenSpaceGuid -> gEfiMdePkgTokenSpaceGuid.PcdDebugClearMemoryValue
+   c. Update the syntax of binary INF file (not PCD related) 
+2. Update DEC files to confirm to DEC spec 0.36
+   Adjust PCD section item format: e.g. PcdWinNtPhysicalDisk|0x00001000|gEfiNt32PkgTokenSpaceGuid|VOID*|L"E:RW;245760;512"-> gEfiNt32PkgTokenSpaceGuid.PcdWinNtFlashFvRecoverySize|0x0|UINT32|0x00001011
+3. Update DSC files to confirm to DSC spec 
+   a. Adjust string/array typed PCD item format: e.g. PcdWinNtMemorySizeForSecMain|gEfiNt32PkgTokenSpaceGuid|L"64!64"|12 -> gEfiNt32PkgTokenSpaceGuid.PcdWinNtMemorySizeForSecMain|L"64!64"|VOID*|12
+   b. Adjust non-string/array typed PCD item format: e.g. PcdWinNtBootMode|gEfiNt32PkgTokenSpaceGuid|1 -> gEfiNt32PkgTokenSpaceGuid.PcdWinNtBootMode|1
+   c. Update the override library class in [Components] section: e.g.
+   <LibraryClass> {
+      PcdLib|MdePkg/Library/BasePcdLibNull/BasePcdLibNull.inf
+   }
+   To 
+   <LibraryClasses> {
+      PcdLib|MdePkg/Library/BasePcdLibNull/BasePcdLibNull.inf
+   }
 
-          
-13-August-2007
+30-August-2007