Re: [PATCH 00/25] Add tools/lib/python modules to Documentation/tools

[Akira Yokosawa <akiyks@gmail.com>]

On Fri, 23 Jan 2026 11:47:30 -0700, Jonathan Corbet wrote:
> Mauro Carvalho Chehab <mchehab+huawei@kernel.org> writes:
> 
>> Hi Jon,
>>
>> This is an extended version of:
>>     https://lore.kernel.org/linux-doc/cover.1768488832.git.mchehab+huawei@kernel.org/
>>
>> It basically adds everything we currently have inside libs/tool/python
>> to "tools" book inside documentation.
> 
> OK, I have applied the set, thanks.

I've not have time to test this set, so just a quick report of a build error
related to this set after the fact.

I'm getting this error from "make SPHINXDIRS=tools pdfdocs":

---- ---- ---- ---- ---- ---- ---- ---- ---- ---- ---- ---- ---- ---- ----
------------
Running 'xelatex --no-pdf  -no-pdf -interaction=batchmode -no-shell-escape -recorder  "/<...>/Documentation/output/tools/latex/tools.tex"'
------------
This is XeTeX, Version 3.141592653-2.6-0.999997 (TeX Live 2025) (preloaded format=xelatex)
entering extended mode
Latexmk: Getting log file 'tools.log'
Latexmk: Examining 'tools.fls'
Latexmk: Examining 'tools.log'
Latexmk: References changed.
Latexmk: Missing input file 'tools.toc' message in .log file:
  No file tools.toc.
Latexmk: Missing input file 'tools.ind' message in .log file:
  No file tools.ind.
Latexmk: References changed.
Latexmk: References changed.
Latexmk: Log file says output to 'tools.xdv'
Latexmk: Index file 'tools.idx' was written
Latexmk: Using bibtex to make bibliography file(s).
Latexmk: Summary of warnings from last run of *latex:
  Latex failed to resolve 15 reference(s)
Latexmk: ====Undefined refs and citations with line #s in .tex file:
  Reference `kabi_parser:module-lib.python.abi.abi_parser' on page 75 undefined on input line 7092
  Reference `kabi_regex:module-lib.python.abi.abi_regex' on page 75 undefined on input line 7093
  Reference `kabi_helpers:module-lib.python.abi.helpers' on page 75 undefined on input line 7094
  Reference `kabi_symbols:module-lib.python.abi.system_symbols' on page 75 undefined on input line 7095
  Reference `feat:module-lib.python.feat.parse_features' on page 75 undefined on input line 7096
  Reference `jobserver:module-lib.python.jobserver' on page 75 undefined on input line 7097
  Reference `kdoc_ancillary:module-lib.python.kdoc.enrich_formatter' on page 75 undefined on input line 7098
 And 8 more --- see log file 'tools.log'
Latexmk: Errors, so I did not complete making targets
Collected error summary (may duplicate other messages):
  xelatex: Command for 'xelatex' gave return code 1
      Refer to 'tools.log' and/or above output for details

Latexmk: Sometimes, the -f option can be used to get latexmk
  to try to force complete processing.
  But normally, you will need to correct the file(s) that caused the
  error, and then rerun latexmk.
  In some cases, it is best to clean out generated files before rerunning
  latexmk after you've corrected the files.
Error: Can't build 1 PDF file(s): tools/pdf/tools.pdf
make[2]: *** [Documentation/Makefile:58: pdfdocs] Error 1
make[1]: *** [/<...>/Makefile:1842: pdfdocs] Error 2
make: *** [Makefile:248: __sub-make] Error 2
---- ---- ---- ---- ---- ---- ---- ---- ---- ---- ---- ---- ---- ---- ----

Excerpt from tools.log:

---- ---- ---- ---- ---- ---- ---- ---- ---- ---- ---- ---- ---- ---- ----
! Text line contains an invalid character.
l.5865 if r’^^A
               ’ is used, it works just like re: it places there the
A funny symbol that I can't read has just been input.
Continue, and I'll forget that it ever happened.
---- ---- ---- ---- ---- ---- ---- ---- ---- ---- ---- ---- ---- ---- ----

, and from tools.tex:

--------
\sphinxAtStartPar
It matches a regex that it is followed by a delimiter,
replacing occurrences only if all delimiters are paired.

\sphinxAtStartPar
if r’\x01’ is used, it works just like re: it places there the  <-- 5865
matched paired data with the delimiter stripped.
--------

Mauro, can you please have a look?

Thanks, Akira

> 
> jon