diff options
| author | Paul Beesley <paul.beesley@arm.com> | 2019-03-13 13:58:02 +0000 |
|---|---|---|
| committer | Paul Beesley <paul.beesley@arm.com> | 2019-05-22 11:28:15 +0100 |
| commit | 8f62ca7b3060b87ede0a55c1972e5d2146a23890 (patch) | |
| tree | c058b9209962e256635e35a5e2afa18ca856532d /docs/index.rst | |
| parent | 57354abb2032b4598ce513d5d1ca788fe3bcf356 (diff) | |
| download | platform_external_arm-trusted-firmware-8f62ca7b3060b87ede0a55c1972e5d2146a23890.tar.gz platform_external_arm-trusted-firmware-8f62ca7b3060b87ede0a55c1972e5d2146a23890.tar.bz2 platform_external_arm-trusted-firmware-8f62ca7b3060b87ede0a55c1972e5d2146a23890.zip | |
doc: Add minimal glossary
One of the current issues with the documentation is that terms and
abbreviations are frequently redefined. For example, we might have
a sentence like "... the SCP (System Control Processor) will ...".
These definitions might be repeated several times across pages, or
even within the same document. Equally, some of these abbreviations
are missed and are never expanded.
Sphinx provides a :term: keyword that takes some text and,
if that text is defined in a glossary document, links to its glossary
entry. Using this functionality will prevent repeated definitions
and will make the docs more maintainable by using a single
definition source.
The glossary added in this patch was created from a quick scrub of
the source code - there may be missing entries. The SDEI abbreviation
was used as an example.
Note that a global_substitutions file was created. This file contains
the RST 'replace' statements that convert plain text terms into linked
terms (by adding the ':term:' keyword to them). An example is:
.. |TF-A| replace:: :term:`TF-A`
The 'rst_prolog' variable in conf.py is used to inject this list of
replacements into each page. Terms must be surrounded with the pipe
character to be turned into links - this means that we can still
prevent certain terms from being linked if we don't want them to be.
Change-Id: I87010ed9cfa4a60011a9b4a431b98cb4bb7baa28
Signed-off-by: Paul Beesley <paul.beesley@arm.com>
Diffstat (limited to 'docs/index.rst')
| -rw-r--r-- | docs/index.rst | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/docs/index.rst b/docs/index.rst index f23b948d0..b0eff61dd 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -15,6 +15,7 @@ Trusted Firmware-A Documentation security_advisories/index change-log acknowledgements + glossary maintainers license @@ -102,7 +103,7 @@ Functionality Secure-EL0, which can be used to implement simple management and security services. - - An SDEI dispatcher to route interrupt-based SDEI events. + - An |SDEI| dispatcher to route interrupt-based |SDEI| events. - An Exception Handling Framework (EHF) that allows dispatching of EL3 interrupts to their registered handlers, to facilitate firmware-first |