diff options
author | Galanakis, Minos <minos.galanakis@arm.com> | 2019-07-04 16:23:10 +0100 |
---|---|---|
committer | Antonio de Angelis <antonio.deangelis@arm.com> | 2019-08-06 09:19:49 +0000 |
commit | 0907261b2b41714509d20acca2954fe2f5dde6e6 (patch) | |
tree | aa698c427b9cb0b0118a0d59bcbebd95b6136847 | |
parent | 66fbdf1123109e23807484fb10526b05db4b3037 (diff) | |
download | trusted-firmware-m-0907261b2b41714509d20acca2954fe2f5dde6e6.tar.gz |
Doc: Updated Document paths
This patch modifes the documentation
in the following ways:
* Contributing, glossary and maintainers
files, are moved into the
the documentation directory
* The table of contents in index.rst.in are
updated accordingly
* Coding_guide, contributing, maintainers and
readme documetns, are updated accordingly
Change-Id: I40ea47f7f154142f1f02f4492ad53c3533109bb0
Signed-off-by: Galanakis, Minos <minos.galanakis@arm.com>
-rw-r--r-- | docs/coding_guide.rst | 2 | ||||
-rw-r--r-- | docs/contributing.rst (renamed from contributing.rst) | 2 | ||||
-rw-r--r-- | docs/glossary.rst (renamed from glossary.rst) | 0 | ||||
-rw-r--r-- | docs/index.rst.in | 8 | ||||
-rw-r--r-- | docs/maintainers.rst (renamed from maintainers.rst) | 2 | ||||
-rw-r--r-- | docs/processes/tfm_design_proposal_process.rst | 2 | ||||
-rw-r--r-- | readme.rst | 8 |
7 files changed, 12 insertions, 12 deletions
diff --git a/docs/coding_guide.rst b/docs/coding_guide.rst index 166442a9c4..aefb2b7b11 100644 --- a/docs/coding_guide.rst +++ b/docs/coding_guide.rst @@ -18,7 +18,7 @@ remain within clear scope. The guidance below is provided as a help. It isn't meant to be a definitive list. -As implied in the :doc:`contributing guide </contributing>` maintainers +As implied in the :doc:`contributing guide </docs/contributing>` maintainers have the right to decide on what's acceptable in case of any divergence. .. Warning:: diff --git a/contributing.rst b/docs/contributing.rst index 691dcde156..f1e5b08c40 100644 --- a/contributing.rst +++ b/docs/contributing.rst @@ -3,7 +3,7 @@ Contributing to Trusted Firmware M Contributions to TF-M project need to follow the process below. -``Note`` Please contact :doc:`maintainers` for any questions. +``Note`` Please contact :doc:`/docs/maintainers` for any questions. - Create an issue in http://issues.trustedfirmware.org to keep others informed about your ongoing work. diff --git a/glossary.rst b/docs/glossary.rst index b50ba4a105..b50ba4a105 100644 --- a/glossary.rst +++ b/docs/glossary.rst diff --git a/docs/index.rst.in b/docs/index.rst.in index 534118f97b..32355ccbbb 100644 --- a/docs/index.rst.in +++ b/docs/index.rst.in @@ -5,7 +5,7 @@ before the documentation is built. This file will be copied to the top level and thus please use relative paths as if this file would be in <TFM_ROOT_DIR>. - + The values between @ characters will be filled in by CMake. @@ -17,10 +17,10 @@ Welcome to TF-M's documentation! :glob: :hidden: - contributing + docs/contributing docs/dco - glossary - maintainers + docs/glossary + docs/maintainers docs/user_guides/tfm_sw_requirement docs/user_guides/tfm_build_instruction docs/coding_guide diff --git a/maintainers.rst b/docs/maintainers.rst index 8a09445283..be99af26f4 100644 --- a/maintainers.rst +++ b/docs/maintainers.rst @@ -6,7 +6,7 @@ be approved and merged by the maintainers listed below. Sub-maintainers' approval is required for their specific areas of ownership. Contributions must follow the instructions in -:doc:`Contributing Guidelines </contributing>`. +:doc:`Contributing Guidelines </docs/contributing>`. Maintainers ----------- diff --git a/docs/processes/tfm_design_proposal_process.rst b/docs/processes/tfm_design_proposal_process.rst index 478220e0b4..1a8ed88bbf 100644 --- a/docs/processes/tfm_design_proposal_process.rst +++ b/docs/processes/tfm_design_proposal_process.rst @@ -95,7 +95,7 @@ Process steps !define REJECTED_DIR **docs/design_documents/rejected/** !define GERRIT_URL https://review.trustedfirmware.org !define GERRIT_LINK [[GERRIT_URL trustedfirmware.org]] - !define MAINTAINER_RST_URL https://git.trustedfirmware.org/trusted-firmware-m.git/tree/maintainers.rst + !define MAINTAINER_RST_URL https://git.trustedfirmware.org/trusted-firmware-m.git/tree/docs/maintainers.rst !define TFM_MAILING_LIST mailto:tf-m@lists.trustedfirmware.org !define NO_DECISION **no** !define YES_DECISION **yes** diff --git a/readme.rst b/readme.rst index f63f9b9b89..c135b284ac 100644 --- a/readme.rst +++ b/readme.rst @@ -11,7 +11,7 @@ for ARMv8-M. however we expect the code to evolve along with the specifications. Terms ``TFM`` and ``TF-M`` are commonly used in documents and code and both -refer to ``Trusted Firmware M.`` :doc:`Glossary </glossary>` has the list +refer to ``Trusted Firmware M.`` :doc:`Glossary </docs/glossary>` has the list of terms and abbreviations. ####### @@ -19,7 +19,7 @@ License ####### The software is provided under a BSD-3-Clause :doc:`License </license>`. Contributions to this project are accepted under the same license with developer -sign-off as described in the :doc:`Contributing Guidelines </contributing>`. +sign-off as described in the :doc:`Contributing Guidelines </docs/contributing>`. This project contains code from other projects as listed below. The code from external projects is limited to ``app`` and ``platform`` folders. @@ -137,9 +137,9 @@ To build & run TF-M: To port TF-M to a another system or OS, follow the :doc:`OS Integration Guide </docs/user_guides/tfm_integration_guide>` -Please also see the :doc:`glossary </glossary>` of terms used in the project. +Please also see the :doc:`glossary </docs/glossary>` of terms used in the project. -:doc:`Contributing Guidelines </contributing>` contains guidance on how to +:doc:`Contributing Guidelines </docs/contributing>` contains guidance on how to contribute to this project. Further documents can be found in the ``docs`` folder. |