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>
diff --git a/docs/coding_guide.rst b/docs/coding_guide.rst
index 166442a..aefb2b7 100644
--- a/docs/coding_guide.rst
+++ b/docs/coding_guide.rst
@@ -18,7 +18,7 @@
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/docs/contributing.rst b/docs/contributing.rst
new file mode 100644
index 0000000..f1e5b08
--- /dev/null
+++ b/docs/contributing.rst
@@ -0,0 +1,42 @@
+Contributing to Trusted Firmware M
+==================================
+
+Contributions to TF-M project need to follow the process below.
+
+``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.
+- If it is a major change then please discuss the design with
+ maintainers.
+- Clone the TF-M code on your own machine from
+ http://git.trustedfirmware.org/trusted-firmware-m.git
+- Follow the :doc:`Coding Guide </docs/coding_guide>` for the TF-M
+ project.
+- Make your changes in logical chunks to help reviewers.
+- Update relevant documentation.
+- Test your changes and add details to the commit description.
+- Add the issue number and details to commit description as well.
+- The code is accepted under :doc:`DCO </docs/dco>`, Developer
+ Certificate of Origin, so you must add following fields to your commit
+ description.::
+
+ Author: Full Name <email address>
+ Signed-off-by: Full Name <email address>
+
+ Note: Sign off authority needs to adhere to the [DCO](./dco.txt) rules.
+
+- You may add other fields in the commit message.
+- Submit your patch for review at
+ http://review.trustedfirmware.org
+- Maintainers will be notified and they will start review process.
+- You may be asked to provide further details or make additional
+ changes.
+- You can discuss further with maintainer(s) offline if necessary.
+- | Once the change is approved by maintainers, the patch can be
+ submitted
+ | either by maintainer or patch owner.
+
+--------------
+
+*Copyright (c) 2017-2019, Arm Limited. All rights reserved.*
diff --git a/docs/glossary.rst b/docs/glossary.rst
new file mode 100644
index 0000000..b50ba4a
--- /dev/null
+++ b/docs/glossary.rst
@@ -0,0 +1,89 @@
+########################################
+TF-M glossary of terms and abbreviations
+########################################
+
+************
+TF-M related
+************
+.. glossary::
+
+ TF-M
+ TFM
+ Trusted Firmware for M-class
+ ARM TF-M provides a reference implementation of secure world software for ARMv8-M.
+
+ SPE : TF-M related
+ Secure Processing Environment
+ PSA term. In TF-M this means the secure domain protected by TF-M
+
+ NSPE : TF-M related
+ Non Secure Processing Enviroment
+ PSA term. In TF-M this means non secure domain typically running an OS using services provided by TF-M
+
+ SS : TF-M related
+ Secure Service
+ A component within the TEE that is atomic from a security/trust point of view, i.e. which is viewed as a single entity from a TF-M point of view
+
+ SP : TF-M related
+ Secure Partition
+ A logical container for a single secure service
+
+ SPM : TF-M related
+ Secure Partition Manager
+ The TF-M component responsible for enumeration, management and isolation of multiple Secure Partitions within the TEE
+
+ SFN : TF-M related
+ Secure Function
+ An entry function to a secure service. Multiple SFN per SS are permitted
+
+ SST : TF-M related
+ Secure Storage Service
+ Secure storage service provided by TF-M
+
+****************
+SSE-200 platform
+****************
+.. glossary::
+
+ MPC : SSE-200 platform
+ Memory Protection Controller
+ Bus slave-side security controller for memory regions
+
+ PPC : SSE-200 platform
+ Peripheral Protection Controller
+ Bus slave-side security controller for peripheral access
+
+************
+v8M-specific
+************
+.. glossary::
+
+ SSE-200 platform
+ Secure/Non-secure
+ The separation provided by TrustZone hardware components in the system
+
+ SAU
+ Secure Attribution Unit
+ Hardware component providing isolation between Secure, Non-secure Callable and Non-secure addresses
+
+
+***************
+M-class Generic
+***************
+.. glossary::
+
+ APCS
+ ARM Architecture Procedure Call Standard
+ The AAPCS defines how subroutines can be separately written, separately compiled, and separately assembled to work together. It describes a contract between a calling routine and a called routine
+
+ SVC
+ SuperVisor Call
+ ARMv7M assembly instruction to call a privileged handler function
+
+ MPU
+ Memory Protection Unit
+ Hardware component providing privilege control
+
+--------------
+
+*Copyright (c) 2017-2019, Arm Limited. All rights reserved.*
diff --git a/docs/index.rst.in b/docs/index.rst.in
index 534118f..32355cc 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 @@
: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/docs/maintainers.rst b/docs/maintainers.rst
new file mode 100644
index 0000000..be99af2
--- /dev/null
+++ b/docs/maintainers.rst
@@ -0,0 +1,77 @@
+Trusted Firmware M - Maintainers
+================================
+
+Trusted Firmware M is a community maintained project. Contributions can only
+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 </docs/contributing>`.
+
+Maintainers
+-----------
+
+Abhishek Pandit
+ :email: `abhishek.pandit@arm.com <abhishek.pandit@arm.com>`__
+ :github: `abhishek-pandit <https://github.com/abhishek-pandit>`__
+
+Ashutosh Singh
+ :email: `ashutosh.singh@arm.com <ashutosh.singh@arm.com>`__
+ :github: `ashutoshksingh <https://github.com/ashutoshksingh>`__
+
+Miklos Balint
+ :email: `miklos.balint@arm.com <miklos.balint@arm.com>`__
+ :github: `wmnt <https://github.com/wmnt>`__
+
+Sub-maintainers
+---------------
+
+Bootloader
+~~~~~~~~~~
+
+Tamas Ban
+ :email: `Tamas.Ban@arm.com <Tamas.Ban@arm.com>`__
+ :github: `tamban01 <https://github.com/tamban01>`__
+
+Secure Storage
+~~~~~~~~~~~~~~
+
+Jamie Fox
+ :email: `jamie.fox@arm.com <jamie.fox@arm.com>`__
+ :github: `jf549 <https://github.com/jf549>`__
+
+Crypto
+~~~~~~
+
+Antonio de Angelis
+ :email: `Antonio.DeAngelis@arm.com <Antonio.DeAngelis@arm.com>`__
+ :github: `adeaarm <https://github.com/adeaarm>`__
+
+SPM & IPC
+~~~~~~~~~
+
+Ken Liu
+ :email: `Ken.Liu@arm.com <Ken.Liu@arm.com>`__
+ :github: `KenLSoft <https://github.com/KenLSoft>`__)
+
+Mate Toth-Pal
+ :email: `Mate.Toth-Pal@arm.com <Mate.Toth-Pal@arm.com>`__
+ :github: `matetothpal <https://github.com/matetothpal>`__)
+
+Audit Log
+~~~~~~~~~
+
+Antonio de Angelis
+ :email: `Antonio.DeAngelis@arm.com <Antonio.DeAngelis@arm.com>`__
+ :github: `adeaarm <https://github.com/adeaarm>`__
+
+Attestation
+~~~~~~~~~~~
+
+Tamas Ban
+ :email: `Tamas.Ban@arm.com <Tamas.Ban@arm.com>`__
+ :github: `tamban01 <https://github.com/tamban01>`__
+
+--------------
+
+*Copyright (c) 2017-2019, Arm Limited. All rights reserved.*
diff --git a/docs/processes/tfm_design_proposal_process.rst b/docs/processes/tfm_design_proposal_process.rst
index 478220e..1a8ed88 100644
--- a/docs/processes/tfm_design_proposal_process.rst
+++ b/docs/processes/tfm_design_proposal_process.rst
@@ -95,7 +95,7 @@
!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**