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 NOTE: Please confirm you have already installed Python on your machine.
  32
  33 In a command window, change to the top-level directory of the EDK II source.
  34
  35 First, set up your workspace. If you have had a setup, please make sure that
  36 you don't have newer *.template in WORKSPACE\BaseTools\Conf. Otherwise remove
  37 *.txt files in WORKSPACE\Conf in advance.
  38     c:\MyWork\edk2\> edksetup newbuild
  39
  40 Second, go to the module directory (For example, MdeModulePkg\Application\HelloWorld),
  41 and then begin to build
  42     c:\MyWork\edk2\> cd MdeModulePkg\Application\HelloWorld
  43     c:\MyWork\edk2\> build
  44
  45 If you want to build the modules in other packages
  46 (For example, MdePkg\Library\BaseLib\BaseLib.inf), please edit open the BaseTools\Conf\Target.txt firstly,
  47
  48 change the following line
  49     ACTIVE_PLATFORM       = MdeModulePkg/MdeModulePkg.dsc
  50 to
  51     ACTIVE_PLATFORM       = MdePkg/MdePkg.dsc
  52
  53 and then go to MdePkg\Library\BaseLib directory and build
  54     c:\MyWork\edk2\> cd MdePkg\Library\BaseLib
  55     c:\MyWork\edk2\> build
  56
  57 If you want build a platform, ACTIVE_PLATFORM must be set to your desired platform dsc file,
  58 go to directory which must be not a module's directory, and run "build" command.
  59
  60 -------------------------------------------------------------------------------
  61 Tools in Python
  62 ---------------
  63
  64 * Run buld tool written in Python from source
  65   The build tool written in Python can be executed from its source directly as long as you
  66 have the Python interpreter (version 2.5) installed. The source of Python code is locating at
  67
  68                 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python
  69
  70         where:
  71
  72                 MyBuild.py      - The temporary "build" tool from which the "build.exe" is coming
  73                 AutoGen.py  - Generate AutoGen.c/.h and makefile only
  74
  75         "MyBuild.py" steps:
  76                 1. Run "edksetup.bat newbuild"
  77                 2. Set ACTIVE_PLATFORM in WORKSPACE\Conf
  78                 3. Go to platform or module directory
  79                 4. Run "<python_interpreter.exe> <python_source_dir>\MyBuild.py" or "<python_source_dir>\MyBuild.py"
  80                    directly.
  81
  82         "AutoGen.py" steps:
  83                 1. Run "edksetup.bat newbuild"
  84                 2. Set ACTIVE_PLATFORM in WORKSPACE\Conf
  85                 4. Run "<python_interpreter.exe> <python_source_dir>\AutoGen.py" or "<python_source_dir>\AutoGen.py"
  86
  87 * Convert Python source to exe file
  88   The tools written in Python can be coverted into executable program which can be executed
  89 without Python interpreter. One of the convertion tools is called cx_Freeze at
  90
  91                 http://sourceforge.net/projects/cx-freeze/
  92
  93         Suppose you have installed cx_Freeze at c:\cx_Freeze-3.0.3. Use following command line to convert MyBuild.py
  94
  95         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
  96
  97         The generated .exe files are put in "mybuild" subdirectory.
  98