Mauro Carvalho Chehab
fc44c0a0b2
docs: kdoc_re: make NestedMatch use KernRe
...
Instead of using re_compile, let's create the class with the
regex and use KernRe to keep it cached.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org >
Reviewed-by: Aleksandr Loktionov <aleksandr.loktionov@intel.com >
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
Message-ID: <cdf900faf0ed8a08f8c6ac1db5a43342968c0739.1772469446.git.mchehab+huawei@kernel.org >
2026-03-03 10:47:25 -07:00
Mauro Carvalho Chehab
34503b5fd1
docs: kdoc_re: Change NestedMath args replacement to \0
...
Future patches will allow parsing each argument instead of the
hole set. Prepare for it by changing the replace all args from
\1 to \0.
No functional changes.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org >
Reviewed-by: Aleksandr Loktionov <aleksandr.loktionov@intel.com >
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
Message-ID: <46e383118be9d9e432e3814fe819ebb12261d7b4.1772469446.git.mchehab+huawei@kernel.org >
2026-03-03 10:47:25 -07:00
Mauro Carvalho Chehab
962bdc440d
docs: kdoc_re: don't recompile NestedMatch regex every time
...
Store delimiters and its regex-compiled version as const vars.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org >
Reviewed-by: Aleksandr Loktionov <aleksandr.loktionov@intel.com >
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
Message-ID: <0cf2b72d4785aa8b727188b56688ff442d1c65ce.1772469446.git.mchehab+huawei@kernel.org >
2026-03-03 10:47:25 -07:00
Mauro Carvalho Chehab
134468b0e2
docs: kdoc_re: handle strings and escape chars on NextMatch
...
The logic inside NestedMatch currently doesn't consider that
function arguments may have chars and strings, which may
eventually contain delimiters.
Add logic to handle strings and escape characters on them.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org >
Reviewed-by: Aleksandr Loktionov <aleksandr.loktionov@intel.com >
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
Message-ID: <ac25335bc2d09649e17d1c86c17d3f8f2e8ec27c.1772469446.git.mchehab+huawei@kernel.org >
2026-03-03 10:47:25 -07:00
Mauro Carvalho Chehab
95a9429cc6
docs: kdoc_re: better show KernRe() at documentation
...
the __repr__() function is used by autodoc to document macro
initialization.
Add a better representation for them.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org >
Reviewed-by: Aleksandr Loktionov <aleksandr.loktionov@intel.com >
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
Message-ID: <80d27732368c14125c1b76048a70d8b4aee527ef.1772469446.git.mchehab+huawei@kernel.org >
2026-03-03 10:47:25 -07:00
Mauro Carvalho Chehab
8eb49357ff
docs: kdoc_re: don't go past the end of a line
...
The logic which checks if the line ends with ";" is currently
broken: it may try to read past the buffer.
Fix it by checking before trying to access line[pos].
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org >
Acked-by: Randy Dunlap <rdunlap@infradead.org >
Tested-by: Randy Dunlap <rdunlap@infradead.org >
Reviewed-by: Aleksandr Loktionov <aleksandr.loktionov@intel.com >
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
Message-ID: <bce51ba0260a053a0ec55a7375d6ed7a7c08026c.1772469446.git.mchehab+huawei@kernel.org >
2026-03-03 10:47:24 -07:00
Mauro Carvalho Chehab
2b144a30a4
docs: kdoc_re: add support for groups()
...
Add an equivalent to re groups() method.
This is useful on debug messages.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org >
Acked-by: Randy Dunlap <rdunlap@infradead.org >
Tested-by: Randy Dunlap <rdunlap@infradead.org >
Reviewed-by: Aleksandr Loktionov <aleksandr.loktionov@intel.com >
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
Message-ID: <20d1a9c77200e28cc2ff1d6122635c43f8ba6a71.1772469446.git.mchehab+huawei@kernel.org >
2026-03-03 10:47:24 -07:00
Mauro Carvalho Chehab
98f51c466a
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 >
2026-02-02 09:57:46 -07:00
Mauro Carvalho Chehab
b0b88915c8
docs: kdoc_re: Improve docstrings and comments
...
In preparation to document kernel-doc module, improve its
documentation.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org >
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
Message-ID: <14a12a43144d52345bfd405d0401d246f0885acf.1768838938.git.mchehab+huawei@kernel.org >
2026-01-23 11:37:38 -07:00
Randy Dunlap
5f88f44d84
docs: kdoc: various fixes for grammar, spelling, punctuation
...
Correct grammar, spelling, and punctuation in comments, strings,
print messages, logs.
Change two instances of two spaces between words to just one space.
codespell was used to find misspelled words.
Signed-off-by: Randy Dunlap <rdunlap@infradead.org >
Cc: Jonathan Corbet <corbet@lwn.net >
Cc: linux-doc@vger.kernel.org
Cc: Mauro Carvalho Chehab <mchehab@kernel.org >
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
Message-ID: <20251124041011.3030571-1-rdunlap@infradead.org >
2025-11-29 08:35:23 -07:00
Jonathan Corbet
778b8ebe51
docs: Move the python libraries to tools/lib/python
...
"scripts/lib" was always a bit of an awkward place for Python modules. We
already have tools/lib; create a tools/lib/python, move the libraries
there, and update the users accordingly.
While at it, move the contents of tools/docs/lib. Rather than make another
directory, just put these documentation-oriented modules under "kdoc".
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
Message-ID: <20251110220430.726665-2-corbet@lwn.net >
2025-11-18 09:22:40 -07:00
