docs(getting-started): Add missing details on the getting started guide
Signed-off-by: Javier Almansa Sobrino <javier.almansasobrino@arm.com>
Change-Id: I9828c4447429193aadeac6cd5f52e9132bcf784e
diff --git a/docs/design/cold-and-warm-boot-design.rst b/docs/design/cold-and-warm-boot-design.rst
index 8729eef..22961b0 100644
--- a/docs/design/cold-and-warm-boot-design.rst
+++ b/docs/design/cold-and-warm-boot-design.rst
@@ -11,8 +11,8 @@
|Boot Design|
Both warm and cold boot enters RMM at the same entry point
-``rmm_entry()``. This scheme simplifies the `boot contract between
-RMM and EL3 <rmm-el3-comms>`_. The boot args as specified by boot
+``rmm_entry()``. This scheme simplifies the
+`RMM-EL3 communications interface`_. The boot args as specified by boot
contract are stashed to high registers.
The boot is divided into several phases as described below:
@@ -40,7 +40,7 @@
The boot args are restored to their original registers and plat_setup()
and plat_warmboot_setup() are invoked for cold and warm boot respectively.
During cold boot, the platform is expected to consume the boot manifest
- which is part of the `boot contract <emm-el3-comms>`_. The platform
+ which is part of the `RMM-EL3 communications interface`_. The platform
initializes any platform specific peripherals and also intializes and
configures the translation table contexts for Stage 1.
@@ -66,9 +66,8 @@
###################################
The communication interface between RMM and EL3 is specified in
-`RMM-EL3 communication interface <rmm-el3-comms>`_ specification in
-TF-A repository.
+`RMM-EL3 communications interface`_ specification in the TF-A repository.
.. |Boot Design| image:: ./diagrams/boot_design.drawio.png
-.. _`rmm-el3-comms`: https://trustedfirmware-a.readthedocs.io/en/latest/components/rmm-el3-comms-spec.html
+.. _`RMM-EL3 communications interface`: https://trustedfirmware-a.readthedocs.io/en/latest/components/rmm-el3-comms-spec.html
diff --git a/docs/getting_started/getting-started.rst b/docs/getting_started/getting-started.rst
index 827c66f..3f9392f 100644
--- a/docs/getting_started/getting-started.rst
+++ b/docs/getting_started/getting-started.rst
@@ -173,7 +173,8 @@
The `TF-RMM Gerrit page`_ under trustedfirmware.org contains a
*Clone with commit-msg hook* subsection under its **Download** header where
-you can copy the command to clone the repo with the required git hooks.
+you can copy the command to clone the repo with the required git hooks. Please
+use the **SSH** option to clone the repository on your local machine.
If needed, you can also manually install the hooks separately on an existing
repo:
diff --git a/docs/process/contributing.rst b/docs/process/contributing.rst
index febcbd3..4667f07 100644
--- a/docs/process/contributing.rst
+++ b/docs/process/contributing.rst
@@ -70,9 +70,11 @@
Submitting Changes
==================
-- Submit your changes for review at https://review.trustedfirmware.org
- targeting the ``integration`` branch. Create a topic that describes
- the target of your changes to help group related patches together.
+- Assuming the clone of the repo has been done as mentioned in the
+ :ref:`getting_started_get_source` and *origin* refers to the upstream repo,
+ submit your changes for review targeting the ``integration`` branch.
+ Create a topic that describes the target of your changes to help group
+ related patches together.
.. code::