ShellBinPkg: Arm/AArch64 Shell binary update.
[mirror_edk2.git] / ShellBinPkg / ReadMe.txt
CommitLineData
072d6116 1============================================================================\r
2 OVERVIEW\r
3============================================================================\r
2f4f828a 4The binaries of ShellBinPkg are generated with ShellPkg project and built with \r
54190e83 5BaseTools Package (r16473). The binaries are built with no debug information \r
2f4f828a 6by building with "RELEASE" target.\r
072d6116 7\r
8The following steps can help to re-generate these binaries for customization:\r
91. Check out EDK II to $(WORKSPACE) \r
fa1dad15 10(svn https://svn.code.sf.net/p/edk2/code/trunk/edk2).\r
2f4f828a 11\r
072d6116 122. Under $(WORKSPACE) directory (i.e. c:\EdkII),\r
2f4f828a 13 To generate Shell, execute:\r
14 "build -a IA32 -a X64 -p ShellPkg\ShellPkg.dsc -b RELEASE"\r
15 To generate Minimal Shell, execute:\r
16 "build -a IA32 -a X64 -p ShellPkg\ShellPkg.dsc -b RELEASE -D NO_SHELL_PROFILES"\r
072d6116 17\r
072d6116 18============================================================================\r
19 HOW TO INCORPORATE THIS SHELL INTO NT32\r
20============================================================================\r
21The instructions below are included as a sample and template on how a \r
22developer may integrate this code into an existing platform:\r
072d6116 23\r
241. Update system PCDs to support this new module\r
25 Update the PCD as follows using the Shell's PCD:\r
3c73ec6c 26 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdShellFile|{ 0x83, 0xA5, \r
27 0x04, 0x7C, 0x3E, 0x9E, 0x1C, 0x4F, 0xAD, 0x65, 0xE0, 0x52, 0x68, 0xD0, \r
28 0xB4, 0xD1 }\r
072d6116 29\r
302. Remove the old shell from the NT32 Firmware list\r
31 Remove the FILE APPLICATION section for the old shell.\r
32\r
333. Add this shell to the NT32 firmware list\r
34 Add the Shell.INF to the end of the list of DXE modules.\r
35\r
364. Build NT32\r
37\r
38============================================================================\r
39 KNOWN LIMITATIONS\r
40============================================================================\r
411. RM can delete current working directory via other map name.\r
2f4f828a 422. DrvCfg does not overlap boot manager functionality.\r
600927af 433. Shell documentation is in development and forthcoming.\r
072d6116 44\r
45============================================================================\r