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