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/change-log.rst | |
| parent | 57354abb2032b4598ce513d5d1ca788fe3bcf356 (diff) | |
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/change-log.rst')
| -rw-r--r-- | docs/change-log.rst | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/docs/change-log.rst b/docs/change-log.rst index 1b6a481f..bbd7feca 100644 --- a/docs/change-log.rst +++ b/docs/change-log.rst @@ -294,12 +294,12 @@ Changed - SDEI - Added support for unconditionally resuming secure world execution after - SDEI event processing completes + |SDEI| event processing completes - SDEI interrupts, although targeting EL3, occur on behalf of the non-secure + |SDEI| interrupts, although targeting EL3, occur on behalf of the non-secure world, and may have higher priority than secure world interrupts. Therefore they might preempt secure execution and yield - execution to the non-secure SDEI handler. Upon completion of SDEI event + execution to the non-secure |SDEI| handler. Upon completion of |SDEI| event handling, resume secure execution if it was preempted. - Translation Tables (XLAT) @@ -501,7 +501,7 @@ New Features - Implement dynamic mitigation for CVE-2018-3639 on Cortex-A76 - - Ensure SDEI handler executes with CVE-2018-3639 mitigation enabled + - Ensure |SDEI| handler executes with CVE-2018-3639 mitigation enabled - Introduce RAS handling on AArch64 @@ -621,7 +621,7 @@ New Features - Introduce jump primitives for BL31 - - Mask events after CPU wakeup in SDEI dispatcher to conform to the + - Mask events after CPU wakeup in |SDEI| dispatcher to conform to the specification - Misc TF-A Core Common Code Enhancements @@ -785,8 +785,8 @@ New features management and security services. The SPM is the firmware component that is responsible for managing a Secure Partition. - - SDEI dispatcher: Support for interrupt-based SDEI events and all - interfaces as defined by the SDEI specification v1.0, see + - SDEI dispatcher: Support for interrupt-based |SDEI| events and all + interfaces as defined by the |SDEI| specification v1.0, see `SDEI Specification`_ - Exception Handling Framework (EHF): Framework that allows dispatching of |