summary refs log tree commit diff stats
path: root/docs/devel/migration
diff options
context:
space:
mode:
authorPaolo Bonzini <pbonzini@redhat.com>2024-10-11 11:45:46 +0200
committerPaolo Bonzini <pbonzini@redhat.com>2024-10-11 13:48:42 +0200
commit381d2c36e1242f849a55f4622e50b9a69cb92842 (patch)
tree2151a3e5f0774565683f6797ede9ab63891f8249 /docs/devel/migration
parent232c3a848e8b291362e29835408011025031d88b (diff)
downloadfocaccia-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/devel/migration')
-rw-r--r--docs/devel/migration/mapped-ram.rst4
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/devel/migration/mapped-ram.rst b/docs/devel/migration/mapped-ram.rst
index d352b546e9..b08c2b433c 100644
--- a/docs/devel/migration/mapped-ram.rst
+++ b/docs/devel/migration/mapped-ram.rst
@@ -44,7 +44,7 @@ Use-cases
 
 The mapped-ram feature was designed for use cases where the migration
 stream will be directed to a file in the filesystem and not
-immediately restored on the destination VM [#]_. These could be
+immediately restored on the destination VM\ [#alternatives]_. These could be
 thought of as snapshots. We can further categorize them into live and
 non-live.
 
@@ -70,7 +70,7 @@ mapped-ram in this scenario is portability since background-snapshot
 depends on async dirty tracking (KVM_GET_DIRTY_LOG) which is not
 supported outside of Linux.
 
-.. [#] While this same effect could be obtained with the usage of
+.. [#alternatives] While this same effect could be obtained with the usage of
        snapshots or the ``file:`` migration alone, mapped-ram provides
        a performance increase for VMs with larger RAM sizes (10s to
        100s of GiBs), specially if the VM has been stopped beforehand.