kernel/linux.git/tools/lib/python/kdoc/kdoc_output.py, branch v7.0-rc7Linux kernel stable tree (mirror)https://git.radix-linux.su/kernel/linux.git/atom?h=v7.0-rc72026-01-23T18:37:38+00:00docs: kdoc_output: Improve docstrings and comments2026-01-23T18:37:38+00:00Mauro Carvalho Chehabmchehab+huawei@kernel.org2026-01-19T16:23:13+00:00urn:sha1:245f1ab2c9bce18a9467b4ef892570dd83b049d2
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: <ac03bf776f0929bbe822cd8269f2a31e275b8d6b.1768838938.git.mchehab+huawei@kernel.org>
kernel-doc: add support to handle DEFINE_ variables2025-12-22T21:43:25+00:00Mauro Carvalho Chehabmchehab+huawei@kernel.org2025-12-16T14:26:13+00:00urn:sha1:bdd1cf87847ff6aaadd53a185209d2bb2db72165
Improve the parser and output plugin to work with macros,
adding support for the common pattern of using DEFINE_*
to create variables.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <757a45100cfc493984574ff780aa9d90506eecb4.1765894964.git.mchehab+huawei@kernel.org>
kernel-doc: add support for handling global variables2025-12-22T21:43:25+00:00Mauro Carvalho Chehabmchehab+huawei@kernel.org2025-12-16T14:26:12+00:00urn:sha1:1045ec382c6019b63cab24428783749a1cecc439
Specially on kAPI, sometimes it is desirable to be able to
describe global variables that are part of kAPI.
Documenting vars with Sphinx is simple, as we don't need
to parse a data struct. All we need is the variable
declaration and use native C domain ::c:var: to format it
for us.
Add support for it.
Link: https://lore.kernel.org/linux-doc/491c3022-cef8-4860-a945-c9c4a3b63c09@infradead.org/T/#m947c25d95cb1d96a394410ab1131dc8e9e5013f1
Suggested-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <fa7d1c61a8de9150f71b318382f1507d3b13848d.1765894964.git.mchehab+huawei@kernel.org>
docs: kdoc: various fixes for grammar, spelling, punctuation2025-11-29T15:35:23+00:00Randy Dunlaprdunlap@infradead.org2025-11-24T04:10:11+00:00urn:sha1:5f88f44d8427a97347afda3a6114aed0df472a0b
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>
docs: bring some order to our Python module hierarchy2025-11-18T16:22:40+00:00Jonathan Corbetcorbet@lwn.net2025-11-10T22:04:30+00:00urn:sha1:992a9df41ad7173588bf90e15b33d45db2811aea
Now that we have tools/lib/python for our Python modules, turn them into
proper packages with a single namespace so that everything can just use
tools/lib/python in sys.path. No functional change.
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <20251110220430.726665-3-corbet@lwn.net>
docs: Move the python libraries to tools/lib/python2025-11-18T16:22:40+00:00Jonathan Corbetcorbet@lwn.net2025-11-10T22:04:29+00:00urn:sha1:778b8ebe5192e7a7f00563a7456517dfa63e1d90
"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>