audk/BaseTools
Garrett Kirkendall 04ae17218d BaseTools: build: Set ReturnCode on POSTBUILD fail
When build.by POSTBUILD handling section returns other than 0, set
ReturnCode to POSTBUILD_ERROR so build.py exits with return code other
than 0.

Fix for https://bugzilla.tianocore.org/show_bug.cgi?id=1977

Cc: Bob Feng <bob.c.feng@intel.com>
Cc: Liming Gao <gaoliming@byosoft.com.cn>
Cc: Yuwei Chen <yuwei.chen@intel.com>

Signed-off-by: Garrett Kirkendall <garrett.kirkendall@amd.com>
Reviewed-by: Liming Gao <gaoliming@byosoft.com.cn>
2021-05-21 06:52:36 +00:00
..
Bin BaseTools: Update the NASM CI dependency 2021-03-08 01:33:44 +00:00
BinPipWrappers BaseTools: Fix BrotliCompress run issue on Linux 2021-02-22 09:51:17 +00:00
BinWrappers BaseTools: Fix BrotliCompress run issue on Linux 2021-02-22 09:51:17 +00:00
Conf BaseTools: Add DTCPP_FLAGS for GCC5 RISCV64 toolchain 2021-05-17 04:22:20 +00:00
Plugin BaseTools/Plugin: Update HostBasedUnitTestRunner to support Linux 2020-05-08 05:54:46 +00:00
Scripts BaseTools: Modify struct parser for StructPcd 2021-03-08 04:01:55 +00:00
Source BaseTools: build: Set ReturnCode on POSTBUILD fail 2021-05-21 06:52:36 +00:00
Tests Revert "BaseTools:code of test python module is moved to edksetup" 2019-05-09 19:02:35 +08:00
UserManuals BaseTools/VfrCompile: Remove framework VFR support 2019-05-09 09:42:54 +08:00
.gitignore BaseTools gitignore: Ignore VS intermediate files *.obj and *.pdb 2016-11-18 11:07:46 +08:00
BuildEnv BaseTools: Fix the ending character for Linux script BuildEnv 2021-02-10 01:48:50 +00:00
Edk2ToolsBuild.py BaseTools: Update Edk2ToolsBuild.py to use multiple threads on Linux 2020-04-07 01:22:04 +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: rename ReadMe.txt to ReadMe.rst 2020-07-21 04:12:32 +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 Add VS2019 Support on ToolSetup Batches 2019-09-23 22:42:41 +08:00
set_vsprefix_envs.bat BaseTools: Fix the issue in VS2017/VS2019 setting 2020-08-14 03:07:59 +00:00
toolsetup.bat BaseTools: Use pip module if available, CI uses it by default 2021-02-09 03:56:37 +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.

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.

Please also refer to the ``BuildNotes.txt`` file for more information on
building under Windows.

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