audk/BaseTools
Joey Vagedes fa789cc68a BaseTools: scan Edk2ToolsBuild.py make output
Adds edk2_logging.scan_compiler_output() to Edk2ToolsBuild.py to catch
some compilation errors and log them as an error.

Cc: Rebecca Cran <rebecca@bsdio.com>
Cc: Liming Gao <gaoliming@byosoft.com.cn>
Cc: Bob Feng <bob.c.feng@intel.com>
Cc: Yuwei Chen <yuwei.chen@intel.com>
Signed-off-by: Joey Vagedes <joeyvagedes@gmail.com>

Reviewed-by: Rebecca Cran <rebecca@bsdio.com>
2023-08-02 15:20:47 +00:00
..
Bin BaseTools: Delete Bin/{CYGWIN_NT-5.1-i686,Darwin-i386} directories 2023-01-30 16:50:14 +00:00
BinPipWrappers BaseTools: Fix BrotliCompress run issue on Linux 2021-02-22 09:51:17 +00:00
BinWrappers BaseTools: Add FMMT Python Tool 2022-05-06 04:22:21 +00:00
Conf BaseTools/tools_def: Add CLANGDWARF support for RISC-V 2023-07-31 12:37:12 +00:00
Plugin BaseTools/Plugin: Too many execute files cause "cmd too long" failure 2023-05-11 05:45:51 +00:00
Scripts BaseTools: BinToPcd: Resolve xdrlib deprecation 2023-08-02 05:23:00 +00:00
Source BaseTools: remove duplicate includes: IndustryStandard/*.h 2023-06-01 10:53:35 +00:00
Tests BaseTools: Update Tests/TestTools.py to allow it to work on Windows 2023-05-11 02:14:12 +00:00
UserManuals BaseTools/VfrCompile: Remove framework VFR support 2019-05-09 09:42:54 +08:00
.gitignore .gitignore: Ignore build tools build logs 2022-07-09 14:57:49 +00:00
BuildEnv Remove bashisms from edksetup.sh and BaseTools/BuildEnv 2023-05-10 12:02:34 +00:00
Edk2ToolsBuild.py BaseTools: scan Edk2ToolsBuild.py make output 2023-08-02 15:20:47 +00:00
GNUmakefile BaseTools: Replace BSD License with BSD+Patent License 2019-04-09 09:10:20 -07:00
Makefile BaseTools: Replace BSD License with BSD+Patent License 2019-04-09 09:10:20 -07:00
ReadMe.rst BaseTools: Add reference to new build instructions 2022-12-16 22:17:18 +00:00
basetools_calling_path_env.yaml BaseTools: Add YAML files with path env and tool extdeps 2019-11-11 13:01:53 -08:00
basetools_path_env.yaml BaseTools: Add YAML files with path env and tool extdeps 2019-11-11 13:01:53 -08:00
get_vsvars.bat BaseTools: Remove VS2008-VS2013 remnants 2023-05-05 11:41:35 +00:00
set_vsprefix_envs.bat BaseTools: Remove VS2008-VS2013 remnants 2023-05-05 11:41:35 +00:00
toolsetup.bat BaseTools: toolsetup.bat always execute PYTHON_HOME 2023-05-29 01:34:28 +00:00

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