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