Add the brief usage guide for Msa2Inf.exe.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@3632 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/BaseTools/ReadMe.txt b/BaseTools/ReadMe.txt
index 55fb4083b3af8f3df06cce3a6051d69fce9b9249..e0f44182593dc160ebcf4961364f97b84b04c4a4 100644 (file)
--- a/BaseTools/ReadMe.txt
+++ b/BaseTools/ReadMe.txt
@@ -33,4 +33,63 @@ Notes:
         or modules because the AutoGen.* files have been be removed. The "makefile" itself\r
         cannot generate AutoGen.* files. Only "build" command can.\r
 \r
-25-Jun-2007\r
+\r
+Brief usage for Module Migration Tool msa2inf.exe:\r
+1. Command line format:\r
+  msa2inf [options]\r
+2. Input Files:\r
+  A syntactically valid MSA file\r
+3. Output Files:\r
+  An extended INF file with possible auto-generated EntryPoint.c, CommonHeader.h/CommonHeader.txt, depending on options and module contents.\r
+4. Prerequisite:\r
+   a. The workspace directory must be specified either by environment variable or \96w option.  \r
+   b. The Framework Database file must exist to specify the available packages in current workspace. \r
+      Two possible locations are: (The first location overrides the second)\r
+            $(WORKSPACE)\Tools\Conf\FrameworkDatabase.db\r
+            $(WORKSPACE)\Conf\FrameworkDatabase.db.  \r
+      The <PackageList> field in FrameworkDatabase.db lists all available packages in current workspace. \r
+      One example:\r
+      <PackageList>\r
+        <Filename>MdePkg/MdePkg.nspd</Filename>\r
+        <Filename>MdeModulePkg/MdeModulePkg.spd</Filename>\r
+        <Filename>IntelFrameworkPkg/IntelFrameworkPkg.spd</Filename>\r
+      </PackageList>\r
+      The package list in FrameworkDatabase.db is important to the final quality of migration:\r
+      (1) It suggests the new package location: Translate package dependency Guid in MSA to Workspace relative path. \r
+         If the package dependency Guid cannot be found in current workspace a warning message is raised. \r
+      (2) It collects the Protocol/Guid/Ppi GuidCName a package contains. \r
+         The GuidCName acts as "clue" to add e.g. #include <Protocol/DiskIo.h> in CommonHeader.h\r
+     \r
+5. Example:\r
+   WORKSAPCE has already been set: $(WORKSPACE) = c:\work\EdkII. \r
+ \r
+   a. msa2inf \96f c:\work\EdkII\Nt32Pkg\WinNtThunkDxe\WinNtThunk.msa \96o c:\work\EdkII\Nt32Pkg\WinNtThunkDxe\WinNtThunk.inf\r
+   b. msa2inf \96f c:\work\EdkII\Nt32Pkg\WinNtThunkDxe\WinNtThunk.msa \96a\r
+   Example a & b are equivalent to migrate WinNtThunk driver from EDKII to EDKII' code base.\r
+  \r
+   c. msa2inf \96f c:\work\EdkII\Nt32Pkg\WinNtThunkDxe\WinNtThunk.msa \96a -c\r
+   The extra "-c" option performs several hardcode mapping due to the naming change in EDKII\92: \r
+      OldMdePkg Guid -> MdePkgGuid, \r
+      EdkModulePkg Guid -> MdeModulePkgGuid, \r
+      EdkGraphicsLib -> GraphicsLib\r
+      HiiLib -> HiiLibFramework\r
+      ...\r
+   \r
+   d. msa2inf \96f c:\work\EdkII\Nt32Pkg\WinNtThunkDxe\WinNtThunk.msa \96m\r
+   The extra "-m" option suppresses the generation of "CommonHeader.h" and leave all C files intact. \r
+   Instead, it generates "CommonHeader.txt". Developers can manually copy its content to a local common header file in a module. \r
+ \r
+6. Known Limitations:\r
+   a. Tool does not Exit Boot Services Callback & Virtual Address Changed Event. Developers need  to handle it manually.\r
+   b. The #include <Library/AbcLib.h> is based on library class naming convention: The header filename for "AbcLib" class are "AbcLib.h" by convention.\r
+   c. The #include <Guid/Xyz.h>, <Protocol/Xyz.h> and <Ppi/Xyz.h> are added based on gGuidCName listed in MSA. \r
+      If a GuidCName cannot map to a package Guid/Protocol/Ppi header file, a warning message is raised.\r
+      If a module uses the definition in a pakcage Guid/Protocol/Ppi header file without list its associative GuidCName, the build will beak. Developer needs to       manually add the include statement.\r
+   d. The [Depex] sections are generated from DXS files with Guid Macro translated to Guid CName by naming convention, etc.\r
+    If tool fails to "guess" the Guid CName from Guid Macro, it will leave the GuidMacro in [Depex] section for manual resolution.\r
+   e. When tool generates [Sources] section, the modifiers for source files are lost. (Need to add proper tool chain, etc)\r
+   f. When tool generates [LibraryClasses] section, the recommended library instances are lost. (No impact to build)\r
+ \r
+\r
+          \r
+13-August-2007\r