blob: 073e335d5e58b84b23087b29d1144960297a6653 [file] [log] [blame]
jcarsey072d6112011-04-19 16:43:53 +00001============================================================================
2 OVERVIEW
3============================================================================
jcarsey2f4f8282011-05-16 22:20:11 +00004The binaries of ShellBinPkg are generated with ShellPkg project and built with
jcarsey7ea5f0c2011-09-19 17:24:20 +00005BaseTools Package (r12380). The binaries are built with no debug information
jcarsey2f4f8282011-05-16 22:20:11 +00006by building with "RELEASE" target.
jcarsey072d6112011-04-19 16:43:53 +00007
8The following steps can help to re-generate these binaries for customization:
91. Check out EDK II to $(WORKSPACE)
jcarsey2f4f8282011-05-16 22:20:11 +000010(svn https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2).
11
jcarsey072d6112011-04-19 16:43:53 +0000122. Under $(WORKSPACE) directory (i.e. c:\EdkII),
jcarsey2f4f8282011-05-16 22:20:11 +000013 To generate Shell, execute:
14 "build -a IA32 -a X64 -p ShellPkg\ShellPkg.dsc -b RELEASE"
15 To generate Minimal Shell, execute:
16 "build -a IA32 -a X64 -p ShellPkg\ShellPkg.dsc -b RELEASE -D NO_SHELL_PROFILES"
jcarsey072d6112011-04-19 16:43:53 +000017
jcarsey072d6112011-04-19 16:43:53 +000018============================================================================
19 HOW TO INCORPORATE THIS SHELL INTO NT32
20============================================================================
21The instructions below are included as a sample and template on how a
22developer may integrate this code into an existing platform:
23
jcarsey072d6112011-04-19 16:43:53 +0000241. Update system PCDs to support this new module
25 Update the PCD as follows using the Shell's PCD:
jcarsey3c73ec62011-04-28 01:39:31 +000026 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdShellFile|{ 0x83, 0xA5,
27 0x04, 0x7C, 0x3E, 0x9E, 0x1C, 0x4F, 0xAD, 0x65, 0xE0, 0x52, 0x68, 0xD0,
28 0xB4, 0xD1 }
jcarsey072d6112011-04-19 16:43:53 +000029
302. Remove the old shell from the NT32 Firmware list
31 Remove the FILE APPLICATION section for the old shell.
32
333. Add this shell to the NT32 firmware list
34 Add the Shell.INF to the end of the list of DXE modules.
35
364. Build NT32
37
38============================================================================
39 KNOWN LIMITATIONS
40============================================================================
411. RM can delete current working directory via other map name.
jcarsey2f4f8282011-05-16 22:20:11 +0000422. DrvCfg does not overlap boot manager functionality.
jcarsey072d6112011-04-19 16:43:53 +0000433. ifConfig permanent settings are under investigation (may not function correctly)
444. Shell documentation is in development and forthcoming.
45
46============================================================================