fix(docs): fixes to the docs to fix build errors
An empty line is required between delaring a code block and its
contents. This wasn't the case for a couple of blocks in prerequisites,
the patch adds them.
Fixed reference in secure-partition-manager.rst
Signed-off-by: Daniel Boulby <daniel.boulby@arm.com>
Change-Id: Ib89819b66de4ec2c33b5dc4bceadeff4faf79cfc
diff --git a/docs/getting_started/prerequisites.rst b/docs/getting_started/prerequisites.rst
index 40d574f..1e3178d 100644
--- a/docs/getting_started/prerequisites.rst
+++ b/docs/getting_started/prerequisites.rst
@@ -64,11 +64,13 @@
'checkpatch.pl' script from linux source tree. To setup and download 'checkpatch.pl':
.. code:: shell
+
./build/setup_checkpatch.sh
Then test it works with:
.. code:: shell
+
make checkpatch
Documentation
diff --git a/docs/secure-partition-manager/secure-partition-manager.rst b/docs/secure-partition-manager/secure-partition-manager.rst
index 8f48be8..20ab826 100644
--- a/docs/secure-partition-manager/secure-partition-manager.rst
+++ b/docs/secure-partition-manager/secure-partition-manager.rst
@@ -860,7 +860,7 @@
A SP subscribes to receiving VM created and/or VM destroyed messages by
specifying the ``vm-availability-messages`` field in its manifest (see
-`ffa-manifest-binding`_). The SPM will only forward messages to the SP if the SP
+`partition properties`_). The SPM will only forward messages to the SP if the SP
is subscribed to the message kind. The SP must reply with the corresponding
direct message response (via the ``FFA_MSG_SEND_DIRECT_RESP`` ABI) after it has
handled the message.
@@ -1888,6 +1888,8 @@
.. _SPMC FVP build configuration: https://github.com/TF-Hafnium/hafnium-project-reference/blob/main/BUILD.gn#L143
+.. _partition properties: https://trustedfirmware-a.readthedocs.io/en/latest/components/ffa-manifest-binding.html#partition-properties
+
.. _device node: https://trustedfirmware-a.readthedocs.io/en/latest/components/ffa-manifest-binding.html#device-regions
.. _memory region node: https://trustedfirmware-a.readthedocs.io/en/latest/components/ffa-manifest-binding.html#memory-regions