diff options
| author | Paul Beesley <paul.beesley@arm.com> | 2019-07-12 11:56:58 +0100 |
|---|---|---|
| committer | Paul Beesley <paul.beesley@arm.com> | 2019-07-12 14:15:25 +0100 |
| commit | 7cb68807fbd2138bfc71ace3548e4366d15daacf (patch) | |
| tree | 2e22846d91a1de1eac0a7177cdf2430081576541 /docs/components/sdei.rst | |
| parent | 3ce3ce07385a6fe55018d825318a9aba2dab7289 (diff) | |
| download | arm-trusted-firmware-7cb68807fbd2138bfc71ace3548e4366d15daacf.tar.gz | |
doc: Generate PlantUML diagrams automatically
Currently we have some pre-rendered versions of certain diagrams
in SVG format. These diagrams have corresponding PlantUML source
that can be rendered automatically as part of the documentation
build, removing the need for any intermediate files.
This patch adds the Sphinx "plantuml" extension, replaces
references to the pre-rendered SVG files within the documents,
and finally removes the SVG files and helper script.
New requirements for building the docs are the
"sphinxcontrib-plantuml" Python module (added to the pip
requirements.txt file) and the Graphviz package (provides the
"dot" binary) which is in the Ubuntu package repositories.
Change-Id: I24b52ee40ff79676212ed7cff350294945f1b50d
Signed-off-by: Paul Beesley <paul.beesley@arm.com>
Diffstat (limited to 'docs/components/sdei.rst')
| -rw-r--r-- | docs/components/sdei.rst | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/components/sdei.rst b/docs/components/sdei.rst index 6d0e1563d..2a777b385 100644 --- a/docs/components/sdei.rst +++ b/docs/components/sdei.rst @@ -26,7 +26,7 @@ The following figure depicts a general sequence involving SDEI client executing at EL2 and an event dispatch resulting from the triggering of a bound interrupt. A commentary is provided below: -.. image:: ../resources/diagrams/plantuml/sdei_general.svg +.. uml:: ../resources/diagrams/plantuml/sdei_general.puml As part of initialisation, the SDEI client binds a Non-secure interrupt [1], and the SDEI dispatcher returns a platform dynamic event number [2]. The client then @@ -234,7 +234,7 @@ on success, or ``-1`` on failure. The following figure depicts a scenario involving explicit dispatch of SDEI event. A commentary is provided below: -.. image:: ../resources/diagrams/plantuml/sdei_explicit_dispatch.svg +.. uml:: ../resources/diagrams/plantuml/sdei_explicit_dispatch.puml As part of initialisation, the SDEI client registers a handler for a platform event [1], enables the event [3], and unmasks the current PE [5]. Note that, |