docs(prerequisites): add system and Python dependencies for Shrinkwrap
This patch documents the minimal set of required packages to support
Shrinkwrap usage in the Hafnium test infrastructure, specifically for
local `hftest.py` execution.
- Adds system-level dependencies: netcat-openbsd, telnet, etc.
- Adds Python package requirements: fdt, pyyaml, termcolor, tuxmake
All other Shrinkwrap integration and usage details are documented
separately.
Change-Id: Ib14672f5d4e93ce2d91c52a75c6843ae0eaa1bc6
Signed-off-by: Jayanth Dodderi Chidanand <jayanthdodderi.chidanand@arm.com>
diff --git a/docs/getting_started/prerequisites.rst b/docs/getting_started/prerequisites.rst
index 387ce03..9ed8d9b 100644
--- a/docs/getting_started/prerequisites.rst
+++ b/docs/getting_started/prerequisites.rst
@@ -56,6 +56,30 @@
make checkpatch
+System and Python Packages for test infrastructure
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The `Shrinkwrap`_ tool is a core component of the hftest scripts and is included
+as a submodule. It relies on the following system packages to function correctly:
+
+.. code:: shell
+
+ sudo apt-get install -y git netcat-openbsd python3 python3-pip telnet
+
+Further, install the required Python packages:
+
+.. code:: shell
+
+ pip3 install --user fdt pyyaml termcolor tuxmake
+
+.. note::
+
+ These manual installation steps are not required if you're using the Docker
+ based test environment. All necessary dependencies—system packages,
+ Python modules, and Shrinkwrap environment configuration—are already
+ pre-installed and automated inside the Docker image provided by the
+ Hafnium repository (see :ref:`Using_Docker`).
+
Documentation
^^^^^^^^^^^^^
@@ -93,8 +117,9 @@
--------------
-*Copyright (c) 2023, Arm Limited. All rights reserved.*
+*Copyright (c) 2023-2025, Arm Limited. All rights reserved.*
+.. _Shrinkwrap: https://shrinkwrap.docs.arm.com
.. _Sphinx: http://www.sphinx-doc.org/en/master/
.. _Poetry: https://python-poetry.org/docs/
.. _pip: https://pip.pypa.io/en/stable/