diff options
| author | Sandrine Bailleux <sandrine.bailleux@arm.com> | 2019-10-28 14:02:51 +0100 |
|---|---|---|
| committer | Sandrine Bailleux <sandrine.bailleux@arm.com> | 2019-10-28 14:19:27 +0100 |
| commit | ec477e7da9dee6eadddec3686f5c19c3f673c125 (patch) | |
| tree | 6a1312811934dc5b371c2191e6cf42815e6f5aae /docs | |
| parent | a74e3a16b50c70a34936b03876c2018c52ae8311 (diff) | |
| download | platform_external_arm-trusted-firmware-ec477e7da9dee6eadddec3686f5c19c3f673c125.tar.gz platform_external_arm-trusted-firmware-ec477e7da9dee6eadddec3686f5c19c3f673c125.tar.bz2 platform_external_arm-trusted-firmware-ec477e7da9dee6eadddec3686f5c19c3f673c125.zip | |
doc: Fix syntax erros in I/O storage layer plantuml diagrams
Some of the plantuml diagrams in the I/O storage abstraction layer
documentation are absent from the rendered version of the porting
guide. The build log (see [1] for example) reports a syntax error in
these files. This is due to the usage of the 'order' keyword on the
participants list, which does not seem to be supported by the version
of plantuml installed on the ReadTheDocs server.
Fix these syntax errors by removing the 'order' keyword altogether. We
simply rely on the participants being declared in the desired order,
which will be the order of display, according to the plantuml
documentation.
[1] https://readthedocs.org/api/v2/build/9870345.txt
Change-Id: Ife35c74cb2f1dac28bda07df395244639a8d6a2b
Signed-off-by: Sandrine Bailleux <sandrine.bailleux@arm.com>
Diffstat (limited to 'docs')
3 files changed, 9 insertions, 9 deletions
diff --git a/docs/resources/diagrams/plantuml/io_dev_init_and_check.puml b/docs/resources/diagrams/plantuml/io_dev_init_and_check.puml index 2752b3326..b7289a246 100644 --- a/docs/resources/diagrams/plantuml/io_dev_init_and_check.puml +++ b/docs/resources/diagrams/plantuml/io_dev_init_and_check.puml @@ -1,7 +1,7 @@ @startuml -participant arm_io_storage order 1 -participant io_storage order 2 +participant arm_io_storage +participant io_storage -> arm_io_storage : plat_get_image_source(image_id, &dev_handle, &image_spec) diff --git a/docs/resources/diagrams/plantuml/io_dev_registration.puml b/docs/resources/diagrams/plantuml/io_dev_registration.puml index 114c3b778..c6f330e6a 100644 --- a/docs/resources/diagrams/plantuml/io_dev_registration.puml +++ b/docs/resources/diagrams/plantuml/io_dev_registration.puml @@ -1,9 +1,9 @@ @startuml -participant arm_io_storage order 1 -participant io_storage order 2 -participant io_fip order 3 -participant io_memmap order 4 +participant arm_io_storage +participant io_storage +participant io_fip +participant io_memmap -> arm_io_storage : arm_io_setup() diff --git a/docs/resources/diagrams/plantuml/io_framework_usage_overview.puml b/docs/resources/diagrams/plantuml/io_framework_usage_overview.puml index eb3e2b4c7..b21a0ae5d 100644 --- a/docs/resources/diagrams/plantuml/io_framework_usage_overview.puml +++ b/docs/resources/diagrams/plantuml/io_framework_usage_overview.puml @@ -1,8 +1,8 @@ @startuml -participant bl_common order 1 -participant arm_io_storage order 2 -participant io_storage order 3 +participant bl_common +participant arm_io_storage +participant io_storage == Platform Setup == |