aboutsummaryrefslogtreecommitdiffstats
path: root/docs/getting_started/index.rst
diff options
context:
space:
mode:
authorPaul Beesley <paul.beesley@arm.com>2019-05-29 13:59:40 +0100
committerPaul Beesley <paul.beesley@arm.com>2019-11-27 10:45:54 +0000
commit43f35ef516b899c82e11bad760c704c44ced5440 (patch)
tree35ef663b1cd776fa3cff9b831d6bb708666409c8 /docs/getting_started/index.rst
parentd537ee795c1390601428d6b5b3499d05b62ad271 (diff)
downloadplatform_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/getting_started/index.rst')
-rw-r--r--docs/getting_started/index.rst9
1 files changed, 8 insertions, 1 deletions
diff --git a/docs/getting_started/index.rst b/docs/getting_started/index.rst
index 07e3753ec..817beaf8e 100644
--- a/docs/getting_started/index.rst
+++ b/docs/getting_started/index.rst
@@ -6,9 +6,16 @@ Getting Started
:caption: Contents
:numbered:
- user-guide
+ prerequisites
docs-build
+ tools-build
+ initial-build
+ build-options
image-terminology
porting-guide
psci-lib-integration-guide
rt-svc-writers-guide
+
+--------------
+
+*Copyright (c) 2019, Arm Limited. All rights reserved.*