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

[Mauro Carvalho Chehab]

On Sat, 24 Jan 2026 09:31:47 +0900
Akira Yokosawa <akiyks@xxxxxxxxx> wrote:

> On Fri, 23 Jan 2026 11:47:30 -0700, Jonathan Corbet wrote:
> > Mauro Carvalho Chehab <mchehab+huawei@xxxxxxxxxx> writes:
> >   
> >> Hi Jon,
> >>
> >> This is an extended version of:
> >>     https://lore.kernel.org/linux-doc/cover.1768488832.git.mchehab+huawei@xxxxxxxxxx/
> >>
> >> 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":

Thanks for reporting it!

I ended forgetting to test PDF build on it. Funny enough, even for
html, this can be problematic. Fixing it is really trivial though: 
just add a single character to the beginning of a docstring:

	--- a/tools/lib/python/kdoc/kdoc_re.py
	+++ b/tools/lib/python/kdoc/kdoc_re.py
	@@ -228,7 +228,7 @@ class NestedMatch:
        	     yield line[t[0]:t[2]]
 
	     def sub(self, regex, sub, line, count=0):
	-        """
	+        r"""
	         This is similar to re.sub:
	 
	         It matches a regex that it is followed by a delimiter,

For it to not consider "\1" as a special character.

Patch sent:

	1a60aea3155a2e7c5e7bb004952739652407fb8c


Thanks,
Mauro