Skip to content

Commit

Permalink
docs: fix invalid footnote syntax
Browse files Browse the repository at this point in the history
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 <[email protected]>
Signed-off-by: Paolo Bonzini <[email protected]>
  • Loading branch information
bonzini committed Oct 11, 2024
1 parent 872e958 commit effb0f7
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/devel/atomics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/devel/build-system.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit effb0f7

Please sign in to comment.