linux/Documentation/sphinx
Jonathan Corbet 0e0bdcea10 docs: kdoc: handle the obsolescensce of docutils.ErrorString()
commit 00d95fcc4d upstream.

The ErrorString() and SafeString() docutils functions were helpers meant to
ease the handling of encodings during the Python 3 transition.  There is no
real need for them after Python 3.6, and docutils 0.22 removes them,
breaking the docs build

Handle this by just injecting our own one-liner version of ErrorString(),
and removing the sole SafeString() call entirely.

Reported-by: Zhixu Liu <zhixu.liu@gmail.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <87ldmnv2pi.fsf@trenco.lwn.net>
[ Salvatore Bonaccorso: Backport to v6.17.y for context changes in
  Documentation/sphinx/kernel_include.py with major refactorings for the v6.18
  development cycle. Backport ErrorString definition as well to
  Documentation/sphinx/kernel_abi.py file for 6.12.y where it is imported
  from docutils before the faccc0ec64 ("docs: sphinx/kernel_abi: adjust
  coding style") change. ]
Suggested-by: Andreas Radke <andreas.radke@mailbox.org>
Signed-off-by: Salvatore Bonaccorso <carnil@debian.org>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
History 2025-11-02 22:15:22 +09:00
..
templates docs/sphinx: Fix TOC scroll hack for the home page 2024-01-23 14:33:13 -07:00
automarkup.py docs: Raise the minimum Sphinx requirement to 2.4.4 2023-12-15 08:36:33 -07:00
cdomain.py docs: Raise the minimum Sphinx requirement to 2.4.4 2023-12-15 08:36:33 -07:00
kernel_abi.py docs: kdoc: handle the obsolescensce of docutils.ErrorString() 2025-11-02 22:15:22 +09:00
kernel_feat.py docs: kdoc: handle the obsolescensce of docutils.ErrorString() 2025-11-02 22:15:22 +09:00
kernel_include.py docs: kdoc: handle the obsolescensce of docutils.ErrorString() 2025-11-02 22:15:22 +09:00
kerneldoc-preamble.sty docs: kerneldoc-preamble.sty: Suppress extra spaces in CJK literal blocks 2024-09-05 14:16:41 -06:00
kerneldoc.py doc: kerneldoc.py: fix indentation 2024-02-21 13:44:21 -07:00
kernellog.py Move our minimum Sphinx version to 1.7 2021-02-01 16:29:12 -07:00
kfigure.py docs: Raise the minimum Sphinx requirement to 2.4.4 2023-12-15 08:36:33 -07:00
load_config.py docs: Fix the docs build with Sphinx 6.0 2023-01-06 13:04:00 -07:00
maintainers_include.py docs: kdoc: handle the obsolescensce of docutils.ErrorString() 2025-11-02 22:15:22 +09:00
parallel-wrapper.sh docs: Fix empty parallelism argument 2020-02-25 03:11:04 -07:00
parse-headers.pl tweewide: Fix most Shebang lines 2020-12-08 23:30:04 +09:00
requirements.txt docs: drop the version constraints for sphinx and dependencies 2024-03-03 08:17:20 -07:00
rstFlatTable.py docs: sphinx: Fix couple of spellings in the file rstFlatTable.py 2021-03-06 17:36:50 -07:00
translations.py docs: translations: use attribute to store current language 2024-02-21 13:41:37 -07:00