chore(docs): reconcile submodule dep info
Remove explicit submodule version info and refer instead to the Git
submodules file. Also add some information for users about how to keep
the repo in sync.
Signed-off-by: Harrison Mutai <harrison.mutai@arm.com>
Change-Id: Iad89dc5f726bb64c65e91a505ac51cc73a905933
diff --git a/docs/getting_started/index.rst b/docs/getting_started/index.rst
index 42a0b5b..8307c14 100644
--- a/docs/getting_started/index.rst
+++ b/docs/getting_started/index.rst
@@ -6,7 +6,6 @@
requirements
docs-build
- obtain
build
build-options
run
diff --git a/docs/getting_started/obtain.rst b/docs/getting_started/obtain.rst
deleted file mode 100644
index 68b4072..0000000
--- a/docs/getting_started/obtain.rst
+++ /dev/null
@@ -1,14 +0,0 @@
-Obtaining Source Code
-=====================
-
-Download the TF-A Tests source code using the following command:
-
-::
-
- git clone --recursive https://git.trustedfirmware.org/TF-A/tf-a-tests.git
-
-Note that TF-A-Tests will also fetch the MbedTLS repo as a git submodule.
-
---------------
-
-*Copyright (c) 2019, Arm Limited. All rights reserved.*
diff --git a/docs/getting_started/requirements.rst b/docs/getting_started/requirements.rst
index e5c1278..6b8964a 100644
--- a/docs/getting_started/requirements.rst
+++ b/docs/getting_started/requirements.rst
@@ -19,16 +19,37 @@
Dependencies
------------
-This section lists the dependencies for TF-A-Tests which are added as
-as a git submodule.
+TFTF includes several dependencies managed as Git submodules. You can find the
+full list of these dependencies in the `.gitmodules`_ file.
-======================== =====================
- Name Version
-======================== =====================
-Mbed TLS 3.6.5
-Transfer List Library 0.0.1
-Event Log Library 0.0.1
-======================== =====================
+Initial Clone with Submodules
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+If you're cloning the repository for the first time, run the following commands
+to initialize and fetch all submodules:
+
+.. code-block:: bash
+
+ git clone --recurse-submodules "https://git.trustedfirmware.org/TF-A/tf-a-tests"
+
+This ensures all submodules are correctly checked out.
+
+Updating Submodules
+^^^^^^^^^^^^^^^^^^^
+
+If the project updates the reference to a submodule (e.g., points to a new
+commit of ``libtl``), you can update your local copy by running:
+
+.. code-block:: bash
+
+ git pull --rebase --no-ff
+ git submodule update --init --recursive
+
+To fetch the latest commits from all submodules, you can use:
+
+.. code-block:: bash
+
+ git submodule update --remote
Toolchain
---------
@@ -52,6 +73,7 @@
.. _GCC cross-toolchain: https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/downloads
.. _Development Studio (Arm-DS): https://developer.arm.com/Tools%20and%20Software/Arm%20Development%20Studio
+.. _.gitmodules: https://review.trustedfirmware.org/plugins/gitiles/TF-A/tf-a-tests/+/refs/heads/master/.gitmodules
--------------