audk/BaseTools
Oliver Smith-Denny 14cb48b0a0 BaseTools: Break Build on Linker Warnings
Today VS2022 and GCC are set to treat all compiler warnings as
errors and break the build. However, linker warnings for both
do not break the build. There are critical errors that can be
treated as warnings as the linker, such as not finding the
module entry point and use a default address as the entry
point. This will cause a runtime crash for something that
should be caught at build time.

This commit adds /WX to VS2022's DLINK_FLAGS and --fatal-warnings
to GCC's DLINK_FLAGS for IA32, X64, ARM, and AARCH64 in order to
break the build on linker warnings.

VS2022 linker warning 4210 is ignored for all builds because it
checks for static initializers and the linking of the VCRuntime.
edk2 never links the VCRuntime (except for HOST_APPLICATIONs) and
so the presence of static initializers will always cause this
warning, even when the edk2 code calls these initializers that
would otherwise be called in the _CRT_INIT function of the
VCRuntime. At the time of this commit, it only fails in CryptoPkg
for building OpenSSL, but could fail anywhere a static initializer
is used.

Signed-off-by: Oliver Smith-Denny <osde@microsoft.com>
2025-01-22 19:47:20 +00:00
..
Bin BaseTools: Move GnuNoteBti.bin to BaseTools 2024-07-23 15:07:41 +00:00
BinWrappers BaseTools: Add FMMT Python Tool 2022-05-06 04:22:21 +00:00
Conf BaseTools: Break Build on Linker Warnings 2025-01-22 19:47:20 +00:00
Plugin BaseTools/Plugin/HostBasedUnitTestRunner: Set ASAN env vars 2025-01-21 05:02:38 +00:00
Scripts BaseTools: fix spelling error 2024-12-11 09:01:03 +08:00
Source BaseTools: Clean up os.path.normcase and os.path.normpath usage 2025-01-09 07:25:45 +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: GenFw: auto-set nxcompat flag 2023-11-06 21:44:34 +00:00
.gitignore BaseTools: Adding cross compilation of BaseTool for Windows ARM/ARM64 2024-12-20 22:57:04 +00:00
BuildEnv BaseTools: Remove Pip BaseTools 2024-09-10 00:41:53 +00:00
Edk2ToolsBuild.py BaseTools: Support custom library build for base tools on Linux ARM 2024-12-20 22:57: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: 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: fix build error with TOOL_CHAIN_TAG VS2015 & VS2015x86 2024-07-30 11:15:27 +00:00
toolsetup.bat Update CI to VS2022 2024-12-10 23:42:09 +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