diff options
| author | Mauro Carvalho Chehab <mchehab+huawei@kernel.org> | 2026-01-27 09:03:32 +0100 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2026-02-02 09:57:46 -0700 |
| commit | 98f51c466aebdb5afa7cb7d54aa7eb9f04b468ee (patch) | |
| tree | 0118061305fcd5aabee110a32755ae1c17f62f4f | |
| parent | 12ea2cff02f8d5b8b480acb6e215ccb41107e154 (diff) | |
docs: kdoc: Fix pdfdocs build for tools
the "\1" inside a docstring requires proper scaping to not be
considered a hex character and break the build.
Reported-by: Akira Yokosawa <akiyks@gmail.com>
Closes: https://lore.kernel.org/linux-doc/63e99049-cc72-4156-83af-414fdde34312@gmail.com/
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <2fff8ef1d0d64e8b68f15f5c07613f302d773855.1769500383.git.mchehab+huawei@kernel.org>
| -rw-r--r-- | tools/lib/python/kdoc/kdoc_re.py | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/tools/lib/python/kdoc/kdoc_re.py b/tools/lib/python/kdoc/kdoc_re.py index 2816bd9f90f8..0bf9e01cdc57 100644 --- a/tools/lib/python/kdoc/kdoc_re.py +++ b/tools/lib/python/kdoc/kdoc_re.py @@ -228,14 +228,18 @@ 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, replacing occurrences only if all delimiters are paired. - if r'\1' is used, it works just like re: it places there the - matched paired data with the delimiter stripped. + if the sub argument contains:: + + r'\1' + + it will work just like re: it places there the matched paired data + with the delimiter stripped. If count is different than zero, it will replace at most count items. |