Remove the unused reference of CommonHeader.h in DxeIpl.inf
[mirror_edk2.git] / BuildNotes2.txt
CommitLineData
e4d8dbc9 1Intel(R) Platform Innovation Framework for EFI\r
2EFI Development Kit II Prime (EDK II Prime)\r
3Root Package 1.00\r
42007-06-25\r
5\r
6Intel is a trademark or registered trademark of Intel Corporation or its\r
7subsidiaries in the United States and other countries.\r
8* Other names and brands may be claimed as the property of others.\r
9Copyright (c) 2007, Intel Corporation\r
10\r
11EDK II Prime packages are in the development phase. They consist of:\r
12\r
f91b9b30 13 BuildNotes2.txt - The build notes for this package\r
14 MdePkg - Industry-standard headers and libraries\r
15 BaseTools - Build -specific tools that are designed to help the\r
16 developer create and modify drivers and libraries\r
17 IntelFrameworkPkg - Tiano/Framework Includes and Libraries\r
18 MdeModulePkg - UEFI 2.1/PI 1.0 compliant modules\r
19 IntelFrameworkModulePKg - Tiano/Framework Includes and Libraries\r
20 Nt32Pkg - UEFI 2.1/PI 1.0 emulation environment for Windows\r
21 FatBinPkg - Binaries built from the FatPkg \r
22 EdkShellBinPkg - Binaries of full shell, minimum shell and commonds(to be added)\r
23\r
24Note:\r
25 EdkShellBinPkg is supported to support both EDK II build and EDKII Prime build by having several module description files.\r
e4d8dbc9 26\r
27-------------------------------------------------------------------------------\r
28Quick Start\r
29-----------\r
30\r
e4d8dbc9 31In a command window, change to the top-level directory of the EDK II source.\r
32\r
11dd6c39 33First, set up your workspace. If you have had a setup, please make sure that\r
34you don't have newer *.template in WORKSPACE\BaseTools\Conf. Otherwise remove\r
35*.txt files in WORKSPACE\Conf in advance.\r
e4d8dbc9 36 c:\MyWork\edk2\> edksetup newbuild\r
37\r
38Second, go to the module directory (For example, MdeModulePkg\Application\HelloWorld),\r
39and then begin to build\r
40 c:\MyWork\edk2\> cd MdeModulePkg\Application\HelloWorld\r
41 c:\MyWork\edk2\> build\r
42\r
43If you want to build the modules in other packages\r
183bc309 44(For example, MdePkg\Library\BaseLib\BaseLib.inf), please edit open the <WORKSPACE>\Conf\Target.txt first,\r
e4d8dbc9 45\r
46change the following line\r
47 ACTIVE_PLATFORM = MdeModulePkg/MdeModulePkg.dsc\r
48to\r
49 ACTIVE_PLATFORM = MdePkg/MdePkg.dsc\r
50\r
51and then go to MdePkg\Library\BaseLib directory and build\r
52 c:\MyWork\edk2\> cd MdePkg\Library\BaseLib\r
53 c:\MyWork\edk2\> build\r
54\r
d57e875c 55If you want build a platform, ACTIVE_PLATFORM must be set to your desired platform dsc file,\r
11dd6c39 56go to directory which must be not a module's directory, and run "build" command.\r
57\r
183bc309 58Instead of changing Target.txt, you can specify platform, module and/or architecture on command line.\r
59For example, if you want to build NT32 platform, you can just type \r
60\r
61 c:\MyWork\edk2\> build -p Nt32Pkg\Nt32Pkg.dsc -a IA32\r
62\r
63and if you want to build HelloWorld module, you can just type\r
64\r
65 c:\MyWork\edk2\> build -p Nt32Pkg\Nt32Pkg.dsc -a IA32 -m MdeModulePkg\Application\HelloWorld\HelloWorld.inf\r
66\r
67Other helpful command line options of build tool include "-v" and "-d". "-v" option is used to turn on\r
68the verbose build, which provide more information during the build. "-d <debug level 0-9>" option is used to\r
69turn on the debug information which is helpful debugging build tools.\r
70\r
71For more information on build options, please try "build -h" on command line. Note that "/?" is not working.\r
72\r
73\r
74-------------------------------------------------------------------------------\r
75Supported build targets\r
76-----------------------\r
77\r
78all - Build whole platform or module. It can be ignored.\r
79clean - Clean intermediate files\r
80cleanall - Clean all generated files and directories during build, except Makefile\r
81cleanlib - Clean all generated files and directories during library build\r
82run - Launch NT32 shell (only valid for NT32 platform)\r
83\r
11dd6c39 84-------------------------------------------------------------------------------\r
85Tools in Python\r
86---------------\r
87\r
88* Run buld tool written in Python from source\r
89 The build tool written in Python can be executed from its source directly as long as you\r
90have the Python interpreter (version 2.5) installed. The source of Python code is locating at\r
91\r
92 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python\r
93\r
94 where:\r
95\r
183bc309 96 Bld.py - The entry tool of build tools\r
11dd6c39 97 AutoGen.py - Generate AutoGen.c/.h and makefile only\r
98\r
99 "MyBuild.py" steps:\r
100 1. Run "edksetup.bat newbuild"\r
101 2. Set ACTIVE_PLATFORM in WORKSPACE\Conf\r
102 3. Go to platform or module directory\r
183bc309 103 4. Run "<python_interpreter.exe> <python_source_dir>\Bld.py" or "<python_source_dir>\Bld.py"\r
11dd6c39 104 directly.\r
105\r
106 "AutoGen.py" steps:\r
107 1. Run "edksetup.bat newbuild"\r
108 2. Set ACTIVE_PLATFORM in WORKSPACE\Conf\r
109 4. Run "<python_interpreter.exe> <python_source_dir>\AutoGen.py" or "<python_source_dir>\AutoGen.py"\r
110\r
111* Convert Python source to exe file\r
112 The tools written in Python can be coverted into executable program which can be executed\r
113without Python interpreter. One of the convertion tools is called cx_Freeze at \r
114\r
115 http://sourceforge.net/projects/cx-freeze/\r
116\r
117 Suppose you have installed cx_Freeze at c:\cx_Freeze-3.0.3. Use following command line to convert MyBuild.py\r
118\r
d57e875c 119 c:\cx_Freeze-3.0.3\FreezePython.exe --include-modules=encodings.cp437,encodings.gbk,encodings.utf_16,encodings.utf_8 --install-dir=.\mybuild MyBuild.py\r
11dd6c39 120\r
121 The generated .exe files are put in "mybuild" subdirectory.\r
e4d8dbc9 122\r