[PATCH 0/3] Tree-wide nreferenced footnotes fixes

Bagas Sanjaya posted 3 patches 11 months ago
Documentation/admin-guide/media/ipu3.rst | 7 ++-----
Documentation/block/ublk.rst             | 2 --
Documentation/power/video.rst            | 2 +-
3 files changed, 3 insertions(+), 8 deletions(-)
[PATCH 0/3] Tree-wide nreferenced footnotes fixes
Posted by Bagas Sanjaya 11 months ago
Sphinx 8.1 introduces improved unrefenced footnotes detector. The changelog
[1] reads:

    - #12730: The UnreferencedFootnotesDetector transform has been improved
      to more consistently detect unreferenced footnotes. Note, the priority
      of the transform has been changed from 200 to 622, so that it now runs
      after the docutils Footnotes resolution transform. Patch by Chris Sewell.

As a result, a few new warnings are smoked out in the whole tree, that
are previously unnoticed in earlier Sphinx versions. Let's squash these
warnings.

[1]: https://lore.kernel.org/linux-next/07507296-a37b-4543-97cb-0560ef7fb7b8@gmail.com/

Bagas Sanjaya (3):
  media: ipu3.rst: Prune unreferenced footnotes
  Documentation: ublk: Drop Stefan Hajnoczi's message footnote
  docs: power: Fix footnote reference for Toshiba Satellite P10-554

 Documentation/admin-guide/media/ipu3.rst | 7 ++-----
 Documentation/block/ublk.rst             | 2 --
 Documentation/power/video.rst            | 2 +-
 3 files changed, 3 insertions(+), 8 deletions(-)


base-commit: ffd294d346d185b70e28b1a28abe367bbfe53c04
-- 
An old man doll... just what I always wanted! - Clara
Re: [PATCH 0/3] Tree-wide nreferenced footnotes fixes
Posted by Jonathan Corbet 11 months ago
Bagas Sanjaya <bagasdotme@gmail.com> writes:

> Sphinx 8.1 introduces improved unrefenced footnotes detector. The changelog
> [1] reads:
>
>     - #12730: The UnreferencedFootnotesDetector transform has been improved
>       to more consistently detect unreferenced footnotes. Note, the priority
>       of the transform has been changed from 200 to 622, so that it now runs
>       after the docutils Footnotes resolution transform. Patch by Chris Sewell.

Something they don't advertise so much, but should: this release also
cuts the docs-build time almost in half for me.  Very nice.

> As a result, a few new warnings are smoked out in the whole tree, that
> are previously unnoticed in earlier Sphinx versions. Let's squash these
> warnings.
>
> [1]: https://lore.kernel.org/linux-next/07507296-a37b-4543-97cb-0560ef7fb7b8@gmail.com/
>
> Bagas Sanjaya (3):
>   media: ipu3.rst: Prune unreferenced footnotes
>   Documentation: ublk: Drop Stefan Hajnoczi's message footnote
>   docs: power: Fix footnote reference for Toshiba Satellite P10-554
>
>  Documentation/admin-guide/media/ipu3.rst | 7 ++-----
>  Documentation/block/ublk.rst             | 2 --
>  Documentation/power/video.rst            | 2 +-
>  3 files changed, 3 insertions(+), 8 deletions(-)

I'll apply these and ship them on up before the end of the merge window,
thanks.

jon