Docs: Clean and restructure the Integration guide
Signed-off-by: Anton Komlev <anton.komlev@arm.com>
Change-Id: I8dca6e3d5cf5cae3a5cd3dc8f2b1e518ab3c20cf
diff --git a/docs/conf.py b/docs/conf.py
index 701419e..425f1a6 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -97,7 +97,7 @@
'prev_next_buttons_location' : None, # Hide Prev and Next buttons
'display_version': True, # Show version under logo
'sticky_navigation': True,
- 'navigation_depth': 2,
+ 'navigation_depth': 3,
}
# Remove the "View page source" link from the top of docs pages
diff --git a/docs/index.rst b/docs/index.rst
index c606c79..8fc23ff 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,5 +1,6 @@
+################################
Trusted Firmware-M Documentation
-================================
+################################
.. raw:: html
@@ -68,6 +69,7 @@
.. toctree::
:caption: Overview
+ :titlesonly:
:maxdepth: 1
:hidden:
@@ -79,6 +81,7 @@
.. toctree::
:caption: Development
+ :titlesonly:
:maxdepth: 1
:hidden:
diff --git a/docs/integration_guide/index.rst b/docs/integration_guide/index.rst
index 31b470b..703c4f7 100644
--- a/docs/integration_guide/index.rst
+++ b/docs/integration_guide/index.rst
@@ -10,9 +10,8 @@
NS client integration <non-secure_client_extension_integration_guide.rst>
OS migration to Armv8-M <os_migration_guide_armv8m.rst>
- tfm_fpu_support.rst
- tfm_secure_irq_integration_guide.rst
- How to add a partition <services/tfm_secure_partition_addition>
+ tfm_fpu_support
+ Secure Interrupt <tfm_secure_irq_integration_guide.rst>
.. toctree::
:maxdepth: 2
diff --git a/docs/integration_guide/platform/index.rst b/docs/integration_guide/platform/index.rst
index 9fd2f2c..c76e327 100644
--- a/docs/integration_guide/platform/index.rst
+++ b/docs/integration_guide/platform/index.rst
@@ -1,12 +1,15 @@
-Porting to a new platform
-=========================
+#####################
+Adding a new platform
+#####################
.. toctree::
:maxdepth: 1
+ platform_folder.rst
+ platform_ext_folder.rst
porting_TFM_to_a_new_hardware
- /platform/readme
- /platform/ext/readme
+ platform_provisioning.rst
+ platform_deprecation.rst
--------------
diff --git a/docs/platform/ext/platform_deprecation.rst b/docs/integration_guide/platform/platform_deprecation.rst
similarity index 94%
rename from docs/platform/ext/platform_deprecation.rst
rename to docs/integration_guide/platform/platform_deprecation.rst
index dff0937..eb981f6 100644
--- a/docs/platform/ext/platform_deprecation.rst
+++ b/docs/integration_guide/platform/platform_deprecation.rst
@@ -54,11 +54,11 @@
| | after | |
| | release | |
+======================================+===========+===========================+
-| mps2/an539 | v1.2.0 | N.A |
+| arm/mps2/an539 | v1.2.0 | N.A |
+--------------------------------------+-----------+---------------------------+
-| mps2/sse-200_aws | v1.3.0 | N.A |
+| arm/mps2/sse-200_aws | v1.3.0 | N.A |
+--------------------------------------+-----------+---------------------------+
-| musca_a | v1.3.0 | N.A |
+| arm/musca_a | v1.3.0 | N.A |
+--------------------------------------+-----------+---------------------------+
| arm/mps2/fvp_sse300 | v1.4.0 | N.A |
+--------------------------------------+-----------+---------------------------+
diff --git a/docs/platform/ext/readme.rst b/docs/integration_guide/platform/platform_ext_folder.rst
similarity index 99%
rename from docs/platform/ext/readme.rst
rename to docs/integration_guide/platform/platform_ext_folder.rst
index da37c46..aa2122c 100644
--- a/docs/platform/ext/readme.rst
+++ b/docs/integration_guide/platform/platform_ext_folder.rst
@@ -1,6 +1,7 @@
###################################
Details for the platform/ext folder
###################################
+
This folder has code that has been imported from other projects. This means the
files in this folder and subfolders have Apache 2.0 license which is different
to BSD 3.0 license applied to the parent TF-M project.
diff --git a/docs/platform/readme.rst b/docs/integration_guide/platform/platform_folder.rst
similarity index 97%
rename from docs/platform/readme.rst
rename to docs/integration_guide/platform/platform_folder.rst
index 550e64c..13b2845 100644
--- a/docs/platform/readme.rst
+++ b/docs/integration_guide/platform/platform_folder.rst
@@ -95,7 +95,7 @@
This folder contains code that has been imported from other projects so it may
have licenses other than the BSD 3.0 used by the TF-M project.
-Please see the :doc:`readme file the ext folder <ext/readme>` for details.
+Please see the :doc:`platform_ext_folder` for details.
--------------
diff --git a/docs/platform/ext/platform_provisioning.rst b/docs/integration_guide/platform/platform_provisioning.rst
similarity index 100%
rename from docs/platform/ext/platform_provisioning.rst
rename to docs/integration_guide/platform/platform_provisioning.rst
diff --git a/docs/integration_guide/services/index.rst b/docs/integration_guide/services/index.rst
index 7567e78..f6251ba 100644
--- a/docs/integration_guide/services/index.rst
+++ b/docs/integration_guide/services/index.rst
@@ -1,9 +1,9 @@
+########
Services
-=========
+########
.. toctree::
:maxdepth: 1
- :glob:
Initial Attestation <tfm_attestation_integration_guide>
Audit Log <tfm_audit_integration_guide>
@@ -12,6 +12,7 @@
Platform <tfm_platform_integration_guide>
Protected Storage <tfm_ps_integration_guide>
PSA Proxy <tfm_psa_proxy_integration_guide>
+ Adding a New Service <tfm_secure_partition_addition>
--------------
diff --git a/docs/integration_guide/services/tfm_its_integration_guide.rst b/docs/integration_guide/services/tfm_its_integration_guide.rst
index 6082e73..2b056cb 100644
--- a/docs/integration_guide/services/tfm_its_integration_guide.rst
+++ b/docs/integration_guide/services/tfm_its_integration_guide.rst
@@ -254,7 +254,7 @@
value will increase the memory footprint of the service.
More information about the ``flash_layout.h`` content, not ITS related, is
-available in :doc:`platform readme </platform/ext/readme>` along with other
+available in :doc:`../platform/platform_ext_folder` along with other
platform information.
ITS Service Build Definitions
diff --git a/docs/integration_guide/services/tfm_ps_integration_guide.rst b/docs/integration_guide/services/tfm_ps_integration_guide.rst
index f64fe3b..104ade3 100644
--- a/docs/integration_guide/services/tfm_ps_integration_guide.rst
+++ b/docs/integration_guide/services/tfm_ps_integration_guide.rst
@@ -260,8 +260,8 @@
the NAND flash implementation. The buffer must be at least as large as a
logical filesystem block.
-More information about the ``flash_layout.h`` content, not PS related, is
-available in :doc:`platform readme </platform/ext/readme>` along with other
+More information about the ``flash_layout.h`` content, not ITS related, is
+available in :doc:`../platform/platform_ext_folder` along with other
platform information.
TF-M NV Counter Interface
diff --git a/docs/platform/ext/index.rst b/docs/platform/ext/index.rst
index 22861e5..da883ef 100644
--- a/docs/platform/ext/index.rst
+++ b/docs/platform/ext/index.rst
@@ -50,13 +50,6 @@
target/nuvoton/**
-.. toctree::
- :maxdepth: 1
- :caption: Rules and processes
-
- platform_deprecation.rst
- platform_provisioning.rst
-
--------------
*Copyright (c) 2020-2021, Arm Limited. All rights reserved.*
diff --git a/docs/platform/ext/platform_introduction.rst b/docs/platform/ext/platform_introduction.rst
index 2d2eb68..b6fecda 100644
--- a/docs/platform/ext/platform_introduction.rst
+++ b/docs/platform/ext/platform_introduction.rst
@@ -66,5 +66,5 @@
- :doc:`RSS. </platform/ext/target/arm/rss/readme>`
-The document :doc:`Platform Deprecation and Removal </platform/ext/platform_deprecation>`
-lists the deprecated platforms planned to be removed from upstream.
+The document :doc:`Platform Deprecation and Removal </integration_guide/platform/platform_deprecation>`
+lists the deprecated platforms, removed from the upstream.
diff --git a/docs/releases/1.3.0.rst b/docs/releases/1.3.0.rst
index fe05e3c..5b73b6c 100644
--- a/docs/releases/1.3.0.rst
+++ b/docs/releases/1.3.0.rst
@@ -60,7 +60,7 @@
- SSE-200_AWS
- AN539
-See :doc:`Platform deprecation and removal </platform/ext/platform_deprecation>`
+See :doc:`/integration_guide/platform/platform_deprecation`
for other platforms under deprecation process.
Tested platforms
diff --git a/docs/releases/1.4.0.rst b/docs/releases/1.4.0.rst
index df4d01c..ec4425e 100644
--- a/docs/releases/1.4.0.rst
+++ b/docs/releases/1.4.0.rst
@@ -42,7 +42,7 @@
- nRF5340 PDK
- Musca_A
-See :doc:`Platform deprecation and removal </platform/ext/platform_deprecation>`
+See :doc:`/integration_guide/platform/platform_deprecation`
for other platforms under deprecation process.
Tested platforms
diff --git a/docs/releases/1.5.0.rst b/docs/releases/1.5.0.rst
index 1d3bb9f..f53c955 100644
--- a/docs/releases/1.5.0.rst
+++ b/docs/releases/1.5.0.rst
@@ -54,7 +54,7 @@
- arm/mps2/fvp_sse300
-See :doc:`Platform deprecation and removal </platform/ext/platform_deprecation>`
+See :doc:`/integration_guide/platform/platform_deprecation`
for other platforms under deprecation process.
Tested platforms
diff --git a/docs/technical_references/design_docs/hardware_abstraction_layer.rst b/docs/technical_references/design_docs/hardware_abstraction_layer.rst
index 7b1361f..33668c9 100644
--- a/docs/technical_references/design_docs/hardware_abstraction_layer.rst
+++ b/docs/technical_references/design_docs/hardware_abstraction_layer.rst
@@ -71,7 +71,8 @@
permitted access to those assets. Currently, :term:`TF-M` only needs the
debug authentication. The whole debug mechanism and related :term:`HAL` will
be enhanced in the future. Please refer to the :doc:`Debug authentication
- settings section </platform/readme>` for more detail.
+ settings section </integration_guide/platform/platform_folder>` for more
+ details.
*****************
Design Principles