mu_basecore/BaseTools
Michael Kubacki 01abd5c3da
BaseTools/Plugin/RustEnvironmentCheck: Add rust-src component check (#611)
## Description

Checks if the rust-src component is installed for the workspace
toolchain.

This is a basic requirement to build firmware code and not having
rust-src can result in an obscure error during firmware build.

- [ ] Impacts functionality?
- **Functionality** - Does the change ultimately impact how firmware
functions?
- Examples: Add a new library, publish a new PPI, update an algorithm,
...
- [ ] Impacts security?
- **Security** - Does the change have a direct security impact on an
application,
    flow, or firmware?
  - Examples: Crypto algorithm change, buffer overflow fix, parameter
    validation improvement, ...
- [ ] Breaking change?
- **Breaking change** - Will anyone consuming this change experience a
break
    in build or boot behavior?
- Examples: Add a new library class, move a module to a different repo,
call
    a function in a new library class in a pre-existing module, ...
- [ ] Includes tests?
  - **Tests** - Does the change include any explicit test code?
  - Examples: Unit tests, integration tests, robot tests, ...
- [ ] Includes documentation?
- **Documentation** - Does the change contain explicit documentation
additions
    outside direct code modifications (and comments)?
- Examples: Update readme file, add feature readme file, link to
documentation
    on an a separate Web page, ...

## How This Was Tested

- Verify with the `rust-src` component installed/uninstalled
- Check on Linux and Windows

## Integration Instructions

N/A - Instructions included in log output

Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
2023-11-06 17:22:37 -05:00
..
Bin BaseTools: Use latest release (#472) 2023-06-26 17:30:22 -07:00
BinPipWrappers BaseTools: Fix BrotliCompress run issue on Linux 2021-02-22 09:51:17 +00:00
BinWrappers BaseTools/OemDataFormatter: Rename to ProductDataFormatter 2023-05-03 17:35:36 -07:00
Conf BaseTools/Conf: Update file versions for Rust changes (#587) 2023-10-07 01:37:20 +00:00
Docs Update all CI infrastructure to support MU 2023-05-03 17:35:30 -07:00
NugetPublishing Adding support of building BaseTool for Windows ARM (#323) 2023-05-08 17:19:46 -07:00
Plugin BaseTools/Plugin/RustEnvironmentCheck: Add rust-src component check (#611) 2023-11-06 17:22:37 -05:00
Scripts BinToPcd.py: Update regex strings to use raw strings (#604) 2023-10-26 22:03:19 +00:00
Source BaseTools: Detect library class mismatch [REBASE&FF] (#499) 2023-07-21 08:54:19 -07:00
Tests BaseTools/Tests: Use quotes around PYTHON_COMMAND 2022-10-24 13:04:40 +00:00
UserManuals BaseTools/VfrCompile: Remove framework VFR support 2019-05-09 09:42:54 +08:00
.gitignore Add Windows ARM 64-bit base tools (#376) 2023-05-09 09:12:30 -07:00
BaseTools.ci.yaml LineEndingsCheck: improve performance (#513) 2023-08-21 08:54:22 -07:00
BuildEnv BaseTools: Fix the ending character for Linux script BuildEnv 2021-02-10 01:48:50 +00:00
Edk2ToolsBuild.py BaseTools: scan Edk2ToolsBuild.py make output (#463) 2023-06-21 16:42:29 -07: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 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: Reset ERRORLEVEL in toolsetup.bat after edk2basetools check 2021-06-25 04:15:40 +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