docs: update `prerequisites`
* Update the prerequisites now that we have updated to
clang-20.
* Instead of linking to the GitHub releases page, link to the
LLVM apt repository, since GitHub releases are not guaranteed
to always have a compiled binary for x86 or Arm64 Linux.
* Include a reference to the Docker container for if the user is
unable to install the toolchain on their host machine.
Change-Id: Iae9214717d543199d363d48134cb02f0997a9421
Signed-off-by: Karl Meakin <karl.meakin@arm.com>
diff --git a/docs/getting_started/building.rst b/docs/getting_started/building.rst
index 0b0935b..62d3e61 100644
--- a/docs/getting_started/building.rst
+++ b/docs/getting_started/building.rst
@@ -90,13 +90,14 @@
issues caused by outdated intermediate files. It's a useful troubleshooting step
but not required for a fresh setup.
+.. _Using_Docker:
+
Using Docker
^^^^^^^^^^^^
-We provide a Docker container to ensure a consistent development environment or
-to enable building on non-Linux platforms (eg MacOS). Build the container with
-`./build/docker/build.sh`. You can run commands in the container with
-`./build/run_in_container.sh -i bash`:
+We provide a Docker container to ensure a consistent development environment.
+Build the container with `./build/docker/build.sh`. You can run commands in the
+container with `./build/run_in_container.sh -i bash`:
.. code:: shell
diff --git a/docs/getting_started/prerequisites.rst b/docs/getting_started/prerequisites.rst
index 1e3178d..387ce03 100644
--- a/docs/getting_started/prerequisites.rst
+++ b/docs/getting_started/prerequisites.rst
@@ -10,36 +10,19 @@
Toolchain
---------
-The following toolchain is recommended for building Hafnium and the test
-infrastructure:
-
-- For a x86_64 Ubuntu host,
-
-.. code:: shell
-
- https://github.com/llvm/llvm-project/releases/download/llvmorg-18.1.8/clang+llvm-18.1.8-x86_64-linux-gnu-ubuntu-18.04.tar.xz
-
-- For a AArch64 Ubuntu host,
-
-.. code:: shell
-
- https://github.com/llvm/llvm-project/releases/download/llvmorg-18.1.8/clang+llvm-18.1.8-aarch64-linux-gnu.tar.xz
+The clang-20 toolchain is recommended for building Hafnium and the test
+infrastructure. On Ubuntu, the toolchain can be installed from the LLVM apt
+repository (https://apt.llvm.org/).
.. note::
- Use of a native toolchain installed on the host (e.g. /usr/bin/clang) is
- not supported.
-
-.. note::
-
- Using a toolchain version greater, or significantly lesser than the one
+ Using a toolchain version greater than, or significantly lesser than the one
specified is not guaranteed to work.
-The PATH environment variable shall be adjusted to contain the LLVM/clang directory, e.g.:
+.. note::
-.. code:: shell
-
- PATH=<toolchain_dir>/clang+llvm-18.1.8-x86_64-linux-gnu-ubuntu-18.04/bin:$PATH
+ You may also use the Docker container if you are unable to install the
+ toolchain on your host machine, see the :ref:`Using_Docker` section.
Dependencies
------------