edk2/BaseTools
Ray Ni d0b64b21a3 BaseTools: Dump library dependency chain on build failure
When a module M depends on L1, which depends on L2,
which depends on L3, the build fails when the library instance
of L3 cannot be found according to the library class-instance
mapping configuration specified in the DSC file.
When such failure happens, the build tool only prints that the
instance of L3 required by module M cannot be found. But it
does not tell how L3 is required by M.

The change enhances build tool to print the entire dependency
chain when such failure happens.
With the change, the new error message will be as follows:

<dsc-path>(...): error 4000: Instance of library class [L3] is not
found for module [M], [L3] is:
  consumed by <instance of L2>
    consumed by <instance of L1>

Signed-off-by: Ray Ni <ray.ni@intel.com>
2025-04-08 08:40:49 +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: Disable VS2019/2022 ARM/AARCH64 Stack Cookies 2025-03-12 06:04:35 +00:00
Plugin BaseTools: Fix Debug Macro Checking to Include Scanning Files 2025-03-13 15:39:06 +00:00
Scripts BaseTools/Scripts/GccBase.lds: Use separate R-W and RW- ELF segments 2025-02-02 09:20:53 +00:00
Source BaseTools: Dump library dependency chain on build failure 2025-04-08 08:40:49 +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

::

  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