diff options
| author | Paolo Bonzini <pbonzini@redhat.com> | 2024-10-11 11:45:46 +0200 |
|---|---|---|
| committer | Paolo Bonzini <pbonzini@redhat.com> | 2024-10-11 13:48:42 +0200 |
| commit | 381d2c36e1242f849a55f4622e50b9a69cb92842 (patch) | |
| tree | 2151a3e5f0774565683f6797ede9ab63891f8249 /docs/specs | |
| parent | 232c3a848e8b291362e29835408011025031d88b (diff) | |
| download | focaccia-qemu-381d2c36e1242f849a55f4622e50b9a69cb92842.tar.gz focaccia-qemu-381d2c36e1242f849a55f4622e50b9a69cb92842.zip | |
docs: use consistent markup for footnotes
Unfortunately, the definition of the footnote syntax requires the author to use the awkward escaped space "\ " in the really common case of "footnote marker at end of word or sentence"; and in fact the rST documentation's examples of footnote syntax contain only artificial examples that do *not* use the syntax. This resulted in ugly rendering of footnotes throughout QEMU's documentation. Ensure the space is escaped whenever the footnote must attach to the preceding word, and also use a named reference for clarity. Reviewed-by: Peter Maydell <peter.maydell@linaro.org> Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
Diffstat (limited to 'docs/specs')
| -rw-r--r-- | docs/specs/fw_cfg.rst | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/specs/fw_cfg.rst b/docs/specs/fw_cfg.rst index 5ad47a901c..31ae31576b 100644 --- a/docs/specs/fw_cfg.rst +++ b/docs/specs/fw_cfg.rst @@ -54,11 +54,11 @@ Data Register ------------- * Read/Write (writes ignored as of QEMU v2.4, but see the DMA interface) -* Location: platform dependent (IOport [#]_ or MMIO) +* Location: platform dependent (IOport\ [#placement]_ or MMIO) * Width: 8-bit (if IOport), 8/16/32/64-bit (if MMIO) * Endianness: string-preserving -.. [#] +.. [#placement] On platforms where the data register is exposed as an IOport, its port number will always be one greater than the port number of the selector register. In other words, the two ports overlap, and can not |