[mirror_edk2.git] / ShellBinPkg / ReadMe.txt

============================================================================\r
                                 OVERVIEW\r
============================================================================\r
The binaries of ShellBinPkg are generated with ShellPkg project and built with \r
BaseTools Package (r14706). 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
(svn https://svn.code.sf.net/p/edk2/code/trunk/edk2).\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
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
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, \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
3. Add this shell to the NT32 firmware list\r
   Add the Shell.INF to the end of the list of DXE modules.\r
\r
4. Build NT32\r
\r
============================================================================\r
                          KNOWN LIMITATIONS\r
============================================================================\r
1. RM can delete current working directory via other map name.\r
2. DrvCfg does not overlap boot manager functionality.\r
3. Shell documentation is in development and forthcoming.\r
\r
============================================================================\r
Commit	Line	Data
	1	============================================================================\r
	2	OVERVIEW\r
	3	============================================================================\r
	4	The binaries of ShellBinPkg are generated with ShellPkg project and built with \r
	5	BaseTools Package (r14706). The binaries are built with no debug information \r
	6	by building with "RELEASE" target.\r
	7	\r
	8	The following steps can help to re-generate these binaries for customization:\r
	9	1. Check out EDK II to $(WORKSPACE) \r
	10	(svn https://svn.code.sf.net/p/edk2/code/trunk/edk2).\r
	11	\r
	12	2. Under $(WORKSPACE) directory (i.e. c:\EdkII),\r
	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
	17	\r
	18	============================================================================\r
	19	HOW TO INCORPORATE THIS SHELL INTO NT32\r
	20	============================================================================\r
	21	The instructions below are included as a sample and template on how a \r
	22	developer may integrate this code into an existing platform:\r
	23	\r
	24	1. Update system PCDs to support this new module\r
	25	Update the PCD as follows using the Shell's PCD:\r
	26	gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdShellFile\|{ 0x83, 0xA5, \r
	27	0x04, 0x7C, 0x3E, 0x9E, 0x1C, 0x4F, 0xAD, 0x65, 0xE0, 0x52, 0x68, 0xD0, \r
	28	0xB4, 0xD1 }\r
	29	\r
	30	2. Remove the old shell from the NT32 Firmware list\r
	31	Remove the FILE APPLICATION section for the old shell.\r
	32	\r
	33	3. 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
	36	4. Build NT32\r
	37	\r
	38	============================================================================\r
	39	KNOWN LIMITATIONS\r
	40	============================================================================\r
	41	1. RM can delete current working directory via other map name.\r
	42	2. DrvCfg does not overlap boot manager functionality.\r
	43	3. Shell documentation is in development and forthcoming.\r
	44	\r
	45	============================================================================\r