Roll back check in r15180 which caused the shell always returns EFI_ABORTED no matter...

[mirror_edk2.git] / ShellBinPkg / ReadMe.txt

diff --git a/ShellBinPkg/ReadMe.txt b/ShellBinPkg/ReadMe.txt
index 344f8a7f1cc8844783e955353e6ac92c261924af..07e298ad0204e381de682ac2f2729d5517d6bcb7 100644 (file)
--- a/ShellBinPkg/ReadMe.txt
+++ b/ShellBinPkg/ReadMe.txt
@@ -1,14 +1,19 @@
 ============================================================================\r
                                  OVERVIEW\r
 ============================================================================\r
 ============================================================================\r
                                  OVERVIEW\r
 ============================================================================\r

-The binaries of ShellBinPkg are generated with ShellPkg project and built with BaseTools Package (r11544). The binaries are built with no debug information by building with "RELEASE" target.\r
+The binaries of ShellBinPkg are generated with ShellPkg project and built with \r
+BaseTools Package (r15999). The binaries are built with no debug information \r
+by building with "RELEASE" target.\r

 \r
 The following steps can help to re-generate these binaries for customization:\r
 1. Check out EDK II to $(WORKSPACE) \r
 \r
 The following steps can help to re-generate these binaries for customization:\r
 1. Check out EDK II to $(WORKSPACE) \r

-(svn https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2).\r
-2. Under $(WORKSPACE) directory (i.e. c:\EdkII),\r
-   To generate Shell, execute: "build -a IA32 -a X64 -p ShellPkg\ShellPkg.dsc -b RELEASE".\r
+(svn https://svn.code.sf.net/p/edk2/code/trunk/edk2).\r

 \r
 \r

+2. Under $(WORKSPACE) directory (i.e. c:\EdkII),\r
+   To generate Shell, execute:\r
+        "build -a IA32 -a X64 -p ShellPkg\ShellPkg.dsc -b RELEASE"\r
+   To generate Minimal Shell, execute:\r
+        "build -a IA32 -a X64 -p ShellPkg\ShellPkg.dsc -b RELEASE -D NO_SHELL_PROFILES"\r

 \r
 ============================================================================\r
                     HOW TO INCORPORATE THIS SHELL INTO NT32\r
 \r
 ============================================================================\r
                     HOW TO INCORPORATE THIS SHELL INTO NT32\r


@@ -16,10 +21,11 @@ The following steps can help to re-generate these binaries for customization:
 The instructions below are included as a sample and template on how a \r
 developer may integrate this code into an existing platform:\r
 \r
 The instructions below are included as a sample and template on how a \r
 developer may integrate this code into an existing platform:\r
 \r

-\r

 1. Update system PCDs to support this new module\r
    Update the PCD as follows using the Shell's PCD:\r
 1. Update system PCDs to support this new module\r
    Update the PCD as follows using the Shell's PCD:\r

-   gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdShellFile|{ 0x83, 0xA5, 0x04, 0x7C, 0x3E, 0x9E, 0x1C, 0x4F, 0xAD, 0x65, 0xE0, 0x52, 0x68, 0xD0, 0xB4, 0xD1 }\r
+   gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdShellFile|{ 0x83, 0xA5, \r
+    0x04, 0x7C, 0x3E, 0x9E, 0x1C, 0x4F, 0xAD, 0x65, 0xE0, 0x52, 0x68, 0xD0, \r
+    0xB4, 0xD1 }\r

 \r
 2. Remove the old shell from the NT32 Firmware list\r
    Remove the FILE APPLICATION section for the old shell.\r
 \r
 2. Remove the old shell from the NT32 Firmware list\r
    Remove the FILE APPLICATION section for the old shell.\r


@@ -33,8 +39,7 @@ developer may integrate this code into an existing platform:
                           KNOWN LIMITATIONS\r
 ============================================================================\r
 1. RM can delete current working directory via other map name.\r
                           KNOWN LIMITATIONS\r
 ============================================================================\r
 1. RM can delete current working directory via other map name.\r

-2. DrvCfg is not functional.\r
-3. ifConfig permanent settings are under investigation (may not function correctly)\r
-4. Shell documentation is in development and forthcoming.\r
+2. DrvCfg does not overlap boot manager functionality.\r
+3. Shell documentation is in development and forthcoming.\r

 \r
 ============================================================================\r
 \r
 ============================================================================\r