Clean codes per ECC for ConSplitterDxe module.

[mirror_edk2.git] / EdkShellBinPkg / ReadMe.txt

diff --git a/EdkShellBinPkg/ReadMe.txt b/EdkShellBinPkg/ReadMe.txt
index 3875b8820453ca81c68a1ebc6da9f5037f6679ab..6718a376d833e72bb98ef8e92097e8d58aec8fed 100644 (file)
--- a/EdkShellBinPkg/ReadMe.txt
+++ b/EdkShellBinPkg/ReadMe.txt
@@ -1,33 +1,21 @@
 The binaries of EdkShellBinPkg are generated with EDK-Shell 1.04 release and build with Edk Compatibility & BaseTools Package\r
-(r4631)\r
+(r4927)\r
 \r
-The following steps are can help to re-generate these binaries for customization:\r
-1. Check out EdkCompatibilityPkg (r4631) to a directory EdkCompatibilityPkg in workspace (svn https://edk2.tianocore.org/svn/edk2/trunk/edk2/EdkCompatibilityPkg). \r
-2. Update to the newest BaseTools package.\r
+The following steps can help to re-generate these binaries for customization:\r
+1. Check out EdkCompatibilityPkg (r4927) to a directory EdkCompatibilityPkg in workspace (svn https://edk2.tianocore.org/svn/edk2/trunk/edk2/EdkCompatibilityPkg). \r
+2. Update to the newest BaseTools package. (r4927 or later)\r
 2. Download EfiShell 1.04.zip from EDK Shell official release https://efi-shell.tianocore.org/servlets/ProjectDocumentList?folderID=52&expandFolder=52&folderID=45\r
-3. Unzip it to the directory in EdkCompatibilityPkg , e.g. c:\EdkII\EdkCompatibilityPkg\Shell\r
-4. Workaround an issue in EdkCompatibilityPkg\Shell\ver\Ver.inf to spit:\r
-  [sources.ia32|x64]\r
-    ia32\ver32.c\r
-\r
-  to be:\r
-  [sources.ia32]\r
-    ia32\ver32.c\r
-\r
-  [sources.x64]\r
-    ia32\ver32.c\r
-\r
-   since current build tools (r4630) does not support this syntax in EDK inf.\r
-\r
-5. Under workspace directory, exectute:\r
+3. Unzip it to be a sub-directory in EdkCompatibilityPkg , i.e. c:\EdkII\EdkCompatibilityPkg\Shell\r
+4. Apply a hot fix Shell_HotFix.diff under EdkShellBinPkg\GenBin directory. This is mainly to fix the unaligned device path node access in shell binary and a rare INF format issue in ver.inf. This patch will be integrated into the later official release.\r
+5. Under workspace directory (i.e. c:\EdkII), execute:\r
    build -a IA32 -a X64 -a IPF -p EdkShellBinPkg\GenBin\EdkShellPkg.dsc -t WINDDK3790x1830\r
    The use of WINDDK instead of MYTOOLS is due to the fact that EDK shell source 1.04 is not\r
    VS2005 clean.\r
 \r
 6. Copy the binaries from Build directory to this package. Typically the EFI binary\r
-   of EdkCompatibility\Shell\$(INF_BASENAME).inf is generaged at:\r
+   of EdkCompatibility\Shell\$(INF_BASENAME).inf is generated at:\r
    Build\EdkShellPkg\DEBUG_WINDDK3790x1830\$(ARCH)\EdkCompatibility\Shell\$(INF_BASENAME)\OUTPUT\$(BASENAME).efi\r
-   for example:\r
+   For example:\r
    The x64 EFI image of EdkCompatibility\Shell\ver\ver.inf is generated at:\r
    Build\EdkShellPkg\DEBUG_WINDDK3790x1830\X64\EdkCompatibilityPkg\Shell\ver\Ver\OUTPUT\ver.efi\r
 \r