qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: Paolo Bonzini <pbonzini@redhat.com>
To: qemu-devel@nongnu.org
Cc: Peter Maydell <peter.maydell@linaro.org>
Subject: [PULL v3 16/18] docs: fix invalid footnote syntax
Date: Fri, 11 Oct 2024 17:32:24 +0200	[thread overview]
Message-ID: <20241011153227.81770-17-pbonzini@redhat.com> (raw)
In-Reply-To: <20241011153227.81770-1-pbonzini@redhat.com>

All footnotes must come after a separator in reStructuredText.  Fix the
two files in which this does not happen.

This mistake causes the link to be rendered literally:

   ...from the venv itself[#distlib]_. If no...

and is caught by Sphinx 8.1.0 as an unreferenced footnote.

Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
---
 docs/devel/atomics.rst      | 2 +-
 docs/devel/build-system.rst | 4 ++--
 2 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/docs/devel/atomics.rst b/docs/devel/atomics.rst
index b77c6e13e18..6bf032f9005 100644
--- a/docs/devel/atomics.rst
+++ b/docs/devel/atomics.rst
@@ -204,7 +204,7 @@ They come in six kinds:
   before the second with respect to the other components of the system.
   Therefore, unlike ``smp_rmb()`` or ``qatomic_load_acquire()``,
   ``smp_read_barrier_depends()`` can be just a compiler barrier on
-  weakly-ordered architectures such as Arm or PPC[#]_.
+  weakly-ordered architectures such as Arm or PPC\ [#]_.
 
   Note that the first load really has to have a _data_ dependency and not
   a control dependency.  If the address for the second load is dependent
diff --git a/docs/devel/build-system.rst b/docs/devel/build-system.rst
index 79eceb179de..fa1c59d9fd8 100644
--- a/docs/devel/build-system.rst
+++ b/docs/devel/build-system.rst
@@ -145,13 +145,13 @@ was installed in the ``site-packages`` directory of another interpreter,
 or with the wrong ``pip`` program.
 
 If a package is available for the chosen interpreter, ``configure``
-prepares a small script that invokes it from the venv itself[#distlib]_.
+prepares a small script that invokes it from the venv itself\ [#distlib]_.
 If not, ``configure`` can also optionally install dependencies in the
 virtual environment with ``pip``, either from wheels in ``python/wheels``
 or by downloading the package with PyPI.  Downloading can be disabled with
 ``--disable-download``; and anyway, it only happens when a ``configure``
 option (currently, only ``--enable-docs``) is explicitly enabled but
-the dependencies are not present[#pip]_.
+the dependencies are not present\ [#pip]_.
 
 .. [#distlib] The scripts are created based on the package's metadata,
               specifically the ``console_script`` entry points.  This is the
-- 
2.46.2



  parent reply	other threads:[~2024-10-11 17:15 UTC|newest]

Thread overview: 28+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-10-11 15:32 [PULL v3 00/18] Rust initial PoC + meson changes for 2024-10-07 Paolo Bonzini
2024-10-11 15:32 ` [PULL v3 01/18] Require meson version 1.5.0 Paolo Bonzini
2024-10-11 15:32 ` [PULL v3 02/18] build-sys: Add rust feature option Paolo Bonzini
2024-10-11 15:32 ` [PULL v3 03/18] configure, meson: detect Rust toolchain Paolo Bonzini
2024-10-11 15:32 ` [PULL v3 04/18] rust: add bindgen step as a meson dependency Paolo Bonzini
2024-10-11 15:32 ` [PULL v3 05/18] .gitattributes: add Rust diff and merge attributes Paolo Bonzini
2024-10-11 15:32 ` [PULL v3 06/18] meson.build: add HAVE_GLIB_WITH_ALIGNED_ALLOC flag Paolo Bonzini
2024-10-11 15:32 ` [PULL v3 07/18] rust: add crate to expose bindings and interfaces Paolo Bonzini
2024-10-11 15:32 ` [PULL v3 08/18] scripts/archive-source: find directory name for subprojects Paolo Bonzini
2024-10-11 15:32 ` [PULL v3 09/18] rust: add utility procedural macro crate Paolo Bonzini
2024-10-11 15:32 ` [PULL v3 10/18] rust: add PL011 device model Paolo Bonzini
2024-10-11 15:32 ` [PULL v3 11/18] meson: fix machine option for x86_version Paolo Bonzini
2024-10-11 15:32 ` [PULL v3 12/18] meson: define qemu_isa_flags Paolo Bonzini
2024-10-11 15:32 ` [PULL v3 13/18] meson: ensure -mcx16 is passed when detecting ATOMIC128 Paolo Bonzini
2024-10-11 15:32 ` [PULL v3 14/18] dockerfiles: add a Dockerfile using a nightly Rust toolchain Paolo Bonzini
2024-10-11 15:32 ` [PULL v3 15/18] gitlab-ci: add Rust-enabled CI job Paolo Bonzini
2024-10-11 15:32 ` Paolo Bonzini [this message]
2024-10-11 15:32 ` [PULL v3 17/18] docs: avoid footnotes consisting of just URLs Paolo Bonzini
2024-10-11 15:32 ` [PULL v3 18/18] docs: use consistent markup for footnotes Paolo Bonzini
2024-10-12 10:54 ` [PULL v3 00/18] Rust initial PoC + meson changes for 2024-10-07 Peter Maydell
2024-10-12 14:02   ` Peter Maydell
2024-10-13 17:39     ` Paolo Bonzini
2024-10-14 10:12 ` Peter Maydell
2024-10-14 10:40   ` Peter Maydell
2024-10-14 10:54     ` Manos Pitsidianakis
2024-10-14 10:54     ` Paolo Bonzini
2024-10-14 10:57     ` Daniel P. Berrangé
2024-10-16 10:46 ` Marc-André Lureau

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20241011153227.81770-17-pbonzini@redhat.com \
    --to=pbonzini@redhat.com \
    --cc=peter.maydell@linaro.org \
    --cc=qemu-devel@nongnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).