Skip to content

Commit 2cc60b5

Browse files
committed
trivial: remove line break for a couple of notes
All our footnotes begin on the same line as their directives, while a couple of notes do not follow this convention. Convert them to the general convention and document in the README. Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>
1 parent 28958ad commit 2cc60b5

2 files changed

Lines changed: 9 additions & 7 deletions

File tree

README.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,10 @@ tag. Generally this means each ``.rst`` file should include the line
155155
In general, try to keep the text width to at most 80 columns.
156156
Try to write footnotes contents as close a possible to the places referencing
157157
them.
158+
Start footnotes and notes on the same line as their directive::
159+
160+
.. [#label] Footnote paragraph
161+
.. note:: Note paragraph
158162

159163
When referencing other specifications, use the following format::
160164

source/chapter2-uefi.rst

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -659,10 +659,9 @@ Firmware must support the delivery of capsules via file on mass storage device
659659
.. [#VarNote] Some Variables are required to support capsule "on disk".
660660
See section :ref:`section-required-vars-for-on-disk`.
661661
662-
.. note::
663-
It is recommended that firmware implementing the `UpdateCapsule()` runtime
664-
service and an ESRT also implement the `EFI_FIRMWARE_MANAGEMENT_PROTOCOL`
665-
described in :UEFI:`23.1`. [#FMProtoNote]_
662+
.. note:: It is recommended that firmware implementing the `UpdateCapsule()`
663+
runtime service and an ESRT also implement the
664+
`EFI_FIRMWARE_MANAGEMENT_PROTOCOL` described in :UEFI:`23.1`. [#FMProtoNote]_
666665

667666
.. [#FMProtoNote] At the time of writing, both Tianocore/EDK2 and U-Boot are
668667
using the `EFI_FIRMWARE_MANAGEMENT_PROTOCOL` internally to support their
@@ -759,9 +758,8 @@ been made optional.
759758
- Notifying the `EFI_EVENT_GROUP_READY_TO_BOOT` and the
760759
`EFI_EVENT_GROUP_AFTER_READY_TO_BOOT` event groups is optional.
761760

762-
.. note::
763-
Other mechanisms exist, which leverage the Boot Manager. For example: the
764-
Linux kernel EFI stub is capable of loading an initial ramdisk using the
761+
.. note:: Other mechanisms exist, which leverage the Boot Manager. For example:
762+
the Linux kernel EFI stub is capable of loading an initial ramdisk using the
765763
`EFI_LOAD_FILE2_PROTOCOL`, while the U-Boot bootloader can use the OSV
766764
specific information contained in the load options `FilePathList[1..n]` to
767765
setup the protocol. [#LF2Note]_

0 commit comments

Comments
 (0)