MdePkg: add missing #defines for decoding PCIe 2.1 extended capability structures
[mirror_edk2.git] / BuildNotes2.txt
e4d8dbc9 1Intel(R) Platform Innovation Framework for EFI\r
a64823fb 2EFI Development Kit II (EDK II)\r
e5b317d0 32011-12-14\r
e4d8dbc9 4\r
5Intel is a trademark or registered trademark of Intel Corporation or its\r
6subsidiaries in the United States and other countries.\r
7* Other names and brands may be claimed as the property of others.\r
e5b317d0 8Copyright (c) 2007 - 2011, Intel Corporation. All rights reserved.\r
e4d8dbc9 9\r
caf30469 10EDK II packages can be checked out from the following SVN address:\r
fa1dad15 11\r
e4d8dbc9 12\r
caf30469 13The detailed introduction of these packages can be found in each package\r
14description file. (The *.dec file under the package directory)\r
1f4c44ad 15\r
e4d8dbc9 16\r
1f4c44ad 18The most recent version of the setup instructions is available on the EDK II\r
caf30469 20\r
1f4c44ad 21\r
24Quick Start (Windows Development Platform)\r
e4d8dbc9 25-----------\r
1f4c44ad 27In a command prompt window, change to the top-level directory of the EDK II \r
e4d8dbc9 29\r
1f4c44ad 30Note:\r
31 The first time the edksetup script is executed, it creates three files in the\r
32 %WORKSPACE%\Conf directory. The files: tools_def.txt, target.txt and\r
33 build_rule.txt, are only created if they do not exist, if they exist, they\r
34 are not touched.\r
36First, set up your project workspace. If you have previously initialized this\r
37WORKSPACE, and a newer version of the *.template files in\r
38WORKSPACE\BaseTools\Conf exists, remove the *.txt files in the WORKSPACE\Conf\r
39directory prior to running the edksetup script.\r
41For the reference build of the Nt32 Platform emulation environment, use the \r
42edksetup.bat option: --nt32. For building other platforms or modules, this\r
43option is not required, as Visual Studio standard includes, libraries and/or\r
44dlls are not required for normal development.\r
8014e7ce 45\r
46 c:\MyWork\edk2\> edksetup --nt32\r
e4d8dbc9 47\r
48The default tool chain (named MYTOOLS) is pre-configured to use VS2008 for IA32\r
49and X64 target architectures and DDK3790 for IPF target architectures. To use a\r
1f4c44ad 50different tool chain, either modify the tools_def.txt file's MYTOOLS entries,\r
51or modify the %WORKSPACE%\Conf\target.txt file's TOOL_CHAIN_TAG. The pre-defined\r
52tags are listed near the top of the %WORKSPACE%\Conf\tools_def.txt file, below\r
53the Supported Tool Chains comment.\r
54Alternatively, you may use the build command's -t option to specify a different\r
55tool chain tag name: build -t VS2008 ... , for example. Using this method will\r
56require that you always use the build command's -t option. If you use 64-bit \r
57windows OS, you should use tool chain tag name with x86, such as VS2008x86.\r
1f4c44ad 58\r
60Next, go to the module directory and begin to build. This example is for the\r
61HelloWorld application.\r
e4d8dbc9 63 c:\MyWork\edk2\> cd MdeModulePkg\Application\HelloWorld\r
64 c:\MyWork\edk2\> build\r
1f4c44ad 66If you want to build the a module in another package (for example, \r
67MdePkg\Library\BaseLib\BaseLib.inf), please edit the file,\r
68%WORKSPACE%\Conf\Target.txt, first.\r
e4d8dbc9 69\r
1f4c44ad 70Change the following line\r
e4d8dbc9 71 ACTIVE_PLATFORM = MdeModulePkg/MdeModulePkg.dsc\r
73 ACTIVE_PLATFORM = MdePkg/MdePkg.dsc\r
1f4c44ad 75Then go to MdePkg\Library\BaseLib directory and type build:\r
e4d8dbc9 76 c:\MyWork\edk2\> cd MdePkg\Library\BaseLib\r
77 c:\MyWork\edk2\> build\r
1f4c44ad 79If you want build a platform, ACTIVE_PLATFORM must be set to your desired\r
80platform dsc file, go to directory which must be not a module's directory, and\r
81run "build" command.\r
11dd6c39 82\r
1f4c44ad 83Instead of changing Target.txt, you can specify platform, module and/or\r
84architecture on command line.\r
183bc309 85For example, if you want to build NT32 platform, you can just type \r
1f4c44ad 87 c:\MyWork\edk2\> build -p Nt32Pkg\Nt32Pkg.dsc -a IA32\r
183bc309 88\r
89and if you want to build HelloWorld module, you can just type\r
1f4c44ad 91 c:\MyWork\edk2\> build -p Nt32Pkg\Nt32Pkg.dsc -a IA32 -m MdeModulePkg\Application\HelloWorld\HelloWorld.inf\r
183bc309 92\r
1f4c44ad 93Other helpful command line options of build tool include "-v" and "-d".\r
94The "-v" option is used to turn on the verbose build, which provide more\r
95information during the build. "-d <debug level 0-9>" option is used to\r
183bc309 96turn on the debug information which is helpful debugging build tools.\r
1f4c44ad 98For more information on build options, please try "build -h" on command line.\r
101 The Windows style help option "/?" is not a valid option for the build\r
102 command.\r
183bc309 103\r
106Supported build targets\r
0c71bc32 109all - Build whole platform or module. It can be ignored.\r
110genc - Generate AutoGen.c, AutoGen.h and <ModuleName>.depex files only.\r
111genmake - Generate makefiles in addition to files generated by "genc" target.\r
183bc309 112clean - Clean intermediate files\r
1f4c44ad 113cleanall - Clean all generated files and directories during build, except the\r
114 generated Makefile files (top level and module makefiles)\r
183bc309 115cleanlib - Clean all generated files and directories during library build\r
0c71bc32 116run - Launch NT32 shell (only valid for NT32 platform)\r
183bc309 117\r
11dd6c39 118-------------------------------------------------------------------------------\r
119Tools in Python\r
122* Run buld tool written in Python from source\r
1f4c44ad 123 The build tool written in Python can be executed from its source directly as\r
e5b317d0 124 long as you have the Python interpreter (version 2.5.4) installed. The source\r
1f4c44ad 125 of Python code is locating at:\r
fa1dad15 127\r
1f4c44ad 128\r
129 where:\r
131 build/ - The entry tool of build tools\r
1f4c44ad 132\r
133 "" steps:\r
134 1. Run "edksetup.bat"\r
135 2. set PYTHONPATH to the local directory of above source\r
136 (BaseTools/Source/Python)\r
138 4. Go to platform or module directory\r
139 5. Run "<python_interpreter.exe> <python_source_dir>/build/" or\r
140 "<python_source_dir>/build/" directly.\r
11dd6c39 142* Convert Python source to exe file\r
1f4c44ad 143 The tools written in Python can be coverted into executable program which can\r
144 be executed without Python interpreter. One of the conversion tools is called\r
145 cx_Freeze, available at: \r
11dd6c39 146\r
1f4c44ad 147\r
11dd6c39 148\r
1f4c44ad 149 If you have installed cx_Freeze at c:\cx_Freeze-3.0.3. Use the following\r
150 command lines to convert to a Windows executable.\r
11dd6c39 151\r
0c71bc32 152 set PYTHONPATH=<buildtools>\BaseTools\Source\Python\r
1f4c44ad 153 c:\cx_Freeze-3.0.3\FreezePython.exe --include-modules=encodings.cp437,encodings.gbk,encodings.utf_16,encodings.utf_8 --install-dir=.\mybuild\r
11dd6c39 154\r
1f4c44ad 155 The generated .exe files are put in "mybuild" subdirectory.\r
e4d8dbc9 156\r