audk/BaseTools
Rebecca Cran 6127bf1f30 BaseTools: Add quotes around OBJCOPY cmd in build_rule.template
Add quotes around the OBJCOPY command in build_rule.template to fix the
case where LLVM is installed on Windows in a path with spaces such as
C:\Program Files\LLVM.

Signed-off-by: Rebecca Cran <rebecca@bsdio.com>
Reviewed-by: Liming Gao <gaoliming@byosoft.com.cn>
Reviewed-by: Bob Feng <bob.c.feng@intel.com>
2023-04-25 06:49:26 +00:00
..
Bin BaseTools: Delete Bin/{CYGWIN_NT-5.1-i686,Darwin-i386} directories 2023-01-30 16:50:14 +00:00
BinPipWrappers
BinWrappers
Conf BaseTools: Add quotes around OBJCOPY cmd in build_rule.template 2023-04-25 06:49:26 +00:00
Plugin BaseTools/Plugin: Clarify code coverage failure message 2023-04-20 22:39:10 +00:00
Scripts BaseTools: Update SetupGit.py to add new 'fp' alias for patch formatting 2023-04-14 14:28:43 +00:00
Source BaseTools/GenFw: Add DllCharacteristicsEx field to debug data 2023-04-07 13:18:38 +00:00
Tests BaseTools/Tests: Use quotes around PYTHON_COMMAND 2022-10-24 13:04:40 +00:00
UserManuals
.gitignore .gitignore: Ignore build tools build logs 2022-07-09 14:57:49 +00:00
BuildEnv
Edk2ToolsBuild.py BaseTools: Edk2ToolsBuild: Fixing pipeline build due to path too long 2022-09-22 12:23:20 +00:00
GNUmakefile
Makefile
ReadMe.rst BaseTools: Add reference to new build instructions 2022-12-16 22:17:18 +00:00
basetools_calling_path_env.yaml
basetools_path_env.yaml
get_vsvars.bat
set_vsprefix_envs.bat
toolsetup.bat

ReadMe.rst

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

::

  Note: New build instructions are available. It is recommended to start with
  the new instructions if learning how to build edk2 and/or BaseTools for the
  first time. This page is retained for reference.

New instructions: `Build Instructions`_

.. _`Build Instructions`: https://github.com/tianocore/tianocore.github.io/wiki/Build-Instructions

This directory contains the EDK II build tools and template files.
Templates are located in the Conf directory, while the tools executables for
Microsoft Windows Operating Systems are located in the Bin\\Win32 directory, other
directory contains tools source.

Build step to generate the binary tools
---------------------------------------

Windows/Visual Studio Notes
===========================

To build the BaseTools, you should run the standard vsvars32.bat script
from your preferred Visual Studio installation or you can run get_vsvars.bat
to use latest automatically detected version.

In addition to this, you should set the following environment variables::

 * EDK_TOOLS_PATH - Path to the BaseTools sub directory under the edk2 tree
 * BASE_TOOLS_PATH - The directory where the BaseTools source is located.
   (It is the same directory where this README.rst is located.)

After this, you can run the toolsetup.bat file, which is in the same
directory as this file.  It should setup the remainder of the environment,
and build the tools if necessary.

Unix-like operating systems
===========================

To build on Unix-like operating systems, you only need to type ``make`` in
the base directory of the project.

Ubuntu Notes
============

On Ubuntu, the following command should install all the necessary build
packages to build all the C BaseTools::

 sudo apt install build-essential uuid-dev