TrustedFirmware Git Browser
Code Review Sign In
review.trustedfirmware.org / TF-M / trusted-firmware-m.git / 35fc447f874f464678742c53de5814254f593ca4 / . / docs / index.rst.in
blob: dfbc49a20db4b0bf7fa3821d20867ba010edf9f4 [file] [log] [blame]
Gyorgy Szing74dae3c2018-09-27 17:00:46 +0200[diff] [blame]1:Page authors: Gyorgy Szing <gyorgy.szing@arm.com>
2
3..
4 The build-system will copy all documents into a temporary directory tree
5 before the documentation is built.
Gyorgy Szing5c873232019-05-10 23:28:14 +0200[diff] [blame]6 This file will be copied to the top level and thus please use relative paths
Gyorgy Szing74dae3c2018-09-27 17:00:46 +0200[diff] [blame]7 as if this file would be in <TFM_ROOT_DIR>.
Galanakis, Minos09072612019-07-04 16:23:10 +0100[diff] [blame]8
Gyorgy Szing5c873232019-05-10 23:28:14 +0200[diff] [blame]9 The values between @ characters will be filled in by CMake.
10
Gyorgy Szing74dae3c2018-09-27 17:00:46 +0200[diff] [blame]11
Galanakis, Minos35fc4472019-10-01 15:19:52 +0100[diff] [blame^]12Trusted Firmware-M Documentation
Gyorgy Szing74dae3c2018-09-27 17:00:46 +0200[diff] [blame]13================================
14
15.. toctree::
16 :maxdepth: 2
Gyorgy Szing74dae3c2018-09-27 17:00:46 +0200[diff] [blame]17 :hidden:
Gyorgy Szingdb9783c2019-04-17 21:08:48 +0200[diff] [blame]18
Galanakis, Minos35fc4472019-10-01 15:19:52 +0100[diff] [blame^]19 docs/lic
Gyorgy Szingdb9783c2019-04-17 21:08:48 +0200[diff] [blame]20 docs/dco
Galanakis, Minos09072612019-07-04 16:23:10 +0100[diff] [blame]21 docs/maintainers
Galanakis, Minos35fc4472019-10-01 15:19:52 +0100[diff] [blame^]22 docs/glossary
23 docs/contributing
Gyorgy Szingdb9783c2019-04-17 21:08:48 +0200[diff] [blame]24 docs/user_guides/tfm_sw_requirement
25 docs/user_guides/tfm_build_instruction
Gyorgy Szingdb9783c2019-04-17 21:08:48 +0200[diff] [blame]26 docs/user_guides/tfm_user_guide
Gyorgy Szingdb9783c2019-04-17 21:08:48 +0200[diff] [blame]27 docs/user_guides/tfm_integration_guide
Galanakis, Minos35fc4472019-10-01 15:19:52 +0100[diff] [blame^]28 docs/coding_guide
29
30.. toctree::
31 :maxdepth: 2
32 :caption: Guides Contd
33 :hidden:
34
35 docs/user_guides/os_migration_guide_armv8m
Gyorgy Szingdb9783c2019-04-17 21:08:48 +0200[diff] [blame]36 docs/user_guides/tfm_ns_client_identification
37 docs/user_guides/tfm_secure_boot
Mate Toth-Pal4341de02018-10-02 12:55:47 +0200[diff] [blame]38 docs/user_guides/tfm_secure_irq_handling
Gyorgy Szingdb9783c2019-04-17 21:08:48 +0200[diff] [blame]39
Gyorgy Szing74dae3c2018-09-27 17:00:46 +0200[diff] [blame]40.. toctree::
Gyorgy Szing5c873232019-05-10 23:28:14 +0200[diff] [blame]41 :caption: Processes
Galanakis, Minos35fc4472019-10-01 15:19:52 +0100[diff] [blame^]42 :maxdepth: 2
Gyorgy Szing5c873232019-05-10 23:28:14 +0200[diff] [blame]43 :glob:
44 :hidden:
45
46 docs/processes/**
47
48.. toctree::
Gyorgy Szing74dae3c2018-09-27 17:00:46 +0200[diff] [blame]49 :caption: Secure services
Galanakis, Minos35fc4472019-10-01 15:19:52 +0100[diff] [blame^]50 :maxdepth: 2
Gyorgy Szing74dae3c2018-09-27 17:00:46 +0200[diff] [blame]51 :glob:
52 :hidden:
Gyorgy Szingdb9783c2019-04-17 21:08:48 +0200[diff] [blame]53
Gyorgy Szing74dae3c2018-09-27 17:00:46 +0200[diff] [blame]54 docs/user_guides/services/*
Gyorgy Szingdb9783c2019-04-17 21:08:48 +0200[diff] [blame]55
Gyorgy Szing74dae3c2018-09-27 17:00:46 +0200[diff] [blame]56.. toctree::
Gyorgy Szing74dae3c2018-09-27 17:00:46 +0200[diff] [blame]57 :caption: Components
Galanakis, Minos35fc4472019-10-01 15:19:52 +0100[diff] [blame^]58 :maxdepth: 2
Gyorgy Szing74dae3c2018-09-27 17:00:46 +0200[diff] [blame]59 :glob:
60 :hidden:
Gyorgy Szingdb9783c2019-04-17 21:08:48 +0200[diff] [blame]61
Gyorgy Szing74dae3c2018-09-27 17:00:46 +0200[diff] [blame]62 lib/**
Gyorgy Szingdb9783c2019-04-17 21:08:48 +0200[diff] [blame]63
Gyorgy Szing74dae3c2018-09-27 17:00:46 +0200[diff] [blame]64.. toctree::
Gyorgy Szing74dae3c2018-09-27 17:00:46 +0200[diff] [blame]65 :caption: Target platforms
Galanakis, Minos35fc4472019-10-01 15:19:52 +0100[diff] [blame^]66 :maxdepth: 2
Gyorgy Szing74dae3c2018-09-27 17:00:46 +0200[diff] [blame]67 :glob:
68 :hidden:
Gyorgy Szingdb9783c2019-04-17 21:08:48 +0200[diff] [blame]69
Gyorgy Szing74dae3c2018-09-27 17:00:46 +0200[diff] [blame]70 platform/**
Gyorgy Szingdb9783c2019-04-17 21:08:48 +0200[diff] [blame]71
Gyorgy Szing74dae3c2018-09-27 17:00:46 +0200[diff] [blame]72.. toctree::
73 :caption: Design documents
74 :maxdepth: 2
75 :glob:
76 :hidden:
Gyorgy Szingdb9783c2019-04-17 21:08:48 +0200[diff] [blame]77
Gyorgy Szing5c873232019-05-10 23:28:14 +0200[diff] [blame]78 @ACCEPTED_DD_LIST@
Gyorgy Szingdb9783c2019-04-17 21:08:48 +0200[diff] [blame]79
Gyorgy Szing74dae3c2018-09-27 17:00:46 +0200[diff] [blame]80.. toctree::
81 :caption: Draft design documents
82 :maxdepth: 2
83 :glob:
84 :hidden:
Gyorgy Szingdb9783c2019-04-17 21:08:48 +0200[diff] [blame]85
Gyorgy Szing5c873232019-05-10 23:28:14 +0200[diff] [blame]86 @DRAFT_DD_LIST@
Gyorgy Szingdb9783c2019-04-17 21:08:48 +0200[diff] [blame]87
Gyorgy Szing74dae3c2018-09-27 17:00:46 +0200[diff] [blame]88.. toctree::
89 :caption: Rejected design documents
90 :maxdepth: 2
91 :glob:
92 :hidden:
Gyorgy Szingdb9783c2019-04-17 21:08:48 +0200[diff] [blame]93
Gyorgy Szing5c873232019-05-10 23:28:14 +0200[diff] [blame]94 @REJECTED_DD_LIST@
Gyorgy Szing74dae3c2018-09-27 17:00:46 +0200[diff] [blame]95
Sergei Trofimov998a09a2019-04-11 09:13:20 +0100[diff] [blame]96.. toctree::
Sergei Trofimov998a09a2019-04-11 09:13:20 +0100[diff] [blame]97 :caption: Tools
Galanakis, Minos35fc4472019-10-01 15:19:52 +0100[diff] [blame^]98 :maxdepth: 2
Sergei Trofimov998a09a2019-04-11 09:13:20 +0100[diff] [blame]99 :glob:
100 :hidden:
Galanakis, Minos35fc4472019-10-01 15:19:52 +0100[diff] [blame^]101
Sergei Trofimov998a09a2019-04-11 09:13:20 +0100[diff] [blame]102 tools/iat-verifier/*
103
Gyorgy Szingdb9783c2019-04-17 21:08:48 +0200[diff] [blame]104.. include:: readme.rst
Gyorgy Szing74dae3c2018-09-27 17:00:46 +0200[diff] [blame]105
106-----------
107
Gyorgy Szingdb9783c2019-04-17 21:08:48 +0200[diff] [blame]108*Copyright (c) 2019, Arm Limited. All rights reserved.*