docs: clarify build environment prerequisites

Our build system extensively uses syntax and tools that are not natively
supported by Windows shells (i.e., CMD.exe and Powershell). This
dependency necessitates a UNIX-compatible build environment. This commit
updates the prerequisites section in our documentation to reflect this.

Change-Id: Ia7e02d7a335e6c88bbaa0394650f1313cdfd6e40
Signed-off-by: Harrison Mutai <harrison.mutai@arm.com>
This commit is contained in:
Harrison Mutai 2024-04-09 11:17:07 +00:00
parent 4b50d7582f
commit ab4d5dfe2f

View file

@ -11,12 +11,11 @@ document can be officially supported.
Build Host Build Host
---------- ----------
|TF-A| can be built using either a Linux or a Windows machine as the build host. |TF-A| can be compiled on both Linux and Windows-based machines.
However, we strongly recommend using a UNIX-compatible build environment.
A relatively recent Linux distribution is recommended for building |TF-A|. We Testing is performed using Ubuntu 22.04 LTS (64-bit), but other distributions
have performed tests using Ubuntu 22.04 LTS (64-bit) but other distributions should also work, provided the necessary tools and libraries are installed.
should also work fine as a base, provided that the necessary tools and libraries
can be installed.
.. _prerequisites_toolchain: .. _prerequisites_toolchain:
@ -42,10 +41,6 @@ In addition, a native compiler is required to build the supporting tools.
which may be older than the version expected by the compiler. Fixes and bug which may be older than the version expected by the compiler. Fixes and bug
reports are always welcome. reports are always welcome.
.. note::
The software has also been built on Windows 7 Enterprise SP1, using CMD.EXE,
Cygwin, and Msys (MinGW) shells, using version 5.3.1 of the GNU toolchain.
.. note:: .. note::
For instructions on how to select the cross compiler refer to For instructions on how to select the cross compiler refer to
:ref:`Performing an Initial Build`. :ref:`Performing an Initial Build`.