docs: use of the docker image
Add a section to the docs mentioning the docker image and the use of the
`HAFNIUM_HERMETIC_BUILD` environment variable.
Change-Id: I6cf22690c432338be3c689a47f932ab047bbb17e
Signed-off-by: Karl Meakin <karl.meakin@arm.com>
diff --git a/docs/getting_started/building.rst b/docs/getting_started/building.rst
index e32b2b0..e419014 100644
--- a/docs/getting_started/building.rst
+++ b/docs/getting_started/building.rst
@@ -74,6 +74,26 @@
So the `args.gn` file will be regenerated with the new values.
+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`:
+
+.. code :: shell
+ ./build/docker/build.sh
+ ./build/run_in_container.sh -i bash
+ make
+
+Alternatively, the Makefile will automatically use the Docker container
+if the environment variable `HAFNIUM_HERMETIC_BUILD` is set to `true`:
+
+.. code :: shell
+ ./build/docker/build.sh
+ HAFNIUM_HERMETIC_BUILD=true make
+
Hafnium Documentation
^^^^^^^^^^^^^^^^^^^^^