diff options
author | Paul Beesley <paul.beesley@arm.com> | 2019-05-29 13:59:40 +0100 |
---|---|---|
committer | Paul Beesley <paul.beesley@arm.com> | 2019-11-27 10:45:54 +0000 |
commit | 43f35ef516b899c82e11bad760c704c44ced5440 (patch) | |
tree | 35ef663b1cd776fa3cff9b831d6bb708666409c8 /docs/process | |
parent | d537ee795c1390601428d6b5b3499d05b62ad271 (diff) | |
download | platform_external_arm-trusted-firmware-43f35ef516b899c82e11bad760c704c44ced5440.tar.gz platform_external_arm-trusted-firmware-43f35ef516b899c82e11bad760c704c44ced5440.tar.bz2 platform_external_arm-trusted-firmware-43f35ef516b899c82e11bad760c704c44ced5440.zip |
doc: Split the User Guide into multiple files
The User Guide document has grown organically over time and
now covers a wide range of topics, making it difficult to
skim read and extract information from. Currently, it covers
these topics and maybe a couple more:
- Requirements (hardware, tools, libs)
- Checking out the repo
- Basic build instructions
- A comprehensive list of build flags
- FIP packaging
- Building specifically for Juno
- Firmware update images
- EL3 payloads
- Preloaded BL33 boot flow
- Running on FVPs
- Running on Juno
I have separated these out into a few groups that become new
documents. Broadly speaking, build instructions for the tools,
for TF-A generally, and for specific scenarios are separated.
Content relating to specific platforms (Juno and the FVPs are
Arm-specific platforms, essentially) has been moved into the
documentation that is specific to those platforms, under
docs/plat/arm.
Change-Id: Ica87c52d8cd4f577332be0b0738998ea3ba3bbec
Signed-off-by: Paul Beesley <paul.beesley@arm.com>
Diffstat (limited to 'docs/process')
-rw-r--r-- | docs/process/contributing.rst | 21 | ||||
-rw-r--r-- | docs/process/security-hardening.rst | 2 |
2 files changed, 12 insertions, 11 deletions
diff --git a/docs/process/contributing.rst b/docs/process/contributing.rst index fdb702ffe..f569fcbe7 100644 --- a/docs/process/contributing.rst +++ b/docs/process/contributing.rst @@ -13,8 +13,8 @@ Getting Started raise a separate `issue`_ for this and ensure that the changes that include Third Party IP are made on a separate topic branch. -- Clone `Trusted Firmware-A`_ on your own machine as suggested in the - :ref:`User Guide`. +- Clone `Trusted Firmware-A`_ on your own machine as described in + :ref:`prerequisites_get_source`. - Create a local topic branch based on the `Trusted Firmware-A`_ ``master`` branch. @@ -26,8 +26,7 @@ Making Changes - Follow the :ref:`Coding Style & Guidelines`. - Use the checkpatch.pl script provided with the Linux source tree. A - Makefile target is provided for convenience (see the "Checking source code - style" section in the :ref:`User Guide`). + Makefile target is provided for convenience. - Keep the commits on topic. If you need to fix another bug or make another enhancement, please create a separate `issue`_ and address it on a separate @@ -38,8 +37,9 @@ Making Changes an `issue`_, include a reference. - Where appropriate, please update the documentation. - - Consider whether the :ref:`User Guide`, :ref:`Porting Guide`, - :ref:`Firmware Design` or other in-source documentation needs updating. + - Consider whether the :ref:`Porting Guide`, + :ref:`Firmware Design` document or other in-source documentation needs + updating. - Ensure that each changed file has the correct copyright and license information. Files that entirely consist of contributions to this project should have a copyright notice and BSD-3-Clause SPDX license @@ -63,9 +63,9 @@ Making Changes include the documentation changes within the single commit. - Please test your changes. As a minimum, ensure that Linux boots on the - Foundation FVP. See :ref:`user_guide_run_fvp` for more information. For - more extensive testing, consider running the `TF-A Tests`_ against your - patches. + Foundation FVP. See :ref:`Arm Fixed Virtual Platforms (FVP)` for more + information. For more extensive testing, consider running the `TF-A Tests`_ + against your patches. Submitting Changes ------------------ @@ -82,7 +82,8 @@ Submitting Changes - Ensure that each commit also has a unique ``Change-Id:`` line. If you have cloned the repository with the "`Clone with commit-msg hook`" clone method - (as advised on the :ref:`User Guide`), this should already be the case. + (following the :ref:`Prerequisites` document), this should already be the + case. More details may be found in the `Gerrit Change-Ids documentation`_. diff --git a/docs/process/security-hardening.rst b/docs/process/security-hardening.rst index 1a5524fd8..86aeb739d 100644 --- a/docs/process/security-hardening.rst +++ b/docs/process/security-hardening.rst @@ -9,7 +9,7 @@ Build options ------------- Several build options can be used to check for security issues. Refer to the -:ref:`User Guide` for detailed information on the specific build options. +:ref:`Build Options` for detailed information on these. - The ``BRANCH_PROTECTION`` build flag can be used to enable Pointer Authentication and Branch Target Identification. |