Merge branch 'mauro-vars' into docs-mw

Browse source

Mauro says:

As suggested and discussed with Randy, this small series add support
for documenting variables using kernel-doc.

- patch 1: add support for the new feature;
- patch 2: extends to support DEFINE_*;
- patch 3: document two media vars;
- patch 4: fix an issue on kernel-doc.rst markups and automarkup;
- patch 5: document it;
- patch 6: better handle DEFINE_ macros when they don't have static/type;

Since version 5, I'm using "c:macro" to describe variables, as it
avoids Sphinx C domain to try parse the variable. This makes it more
flexible and easier to maintain in long term.

...

This commit is contained in:

Jonathan Corbet 2025-12-22 14:52:57 -07:00

parent 82e87387f6 aaacd70fb7

commit d07e0857dc

4 changed files with 172 additions and 16 deletions

Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL

Download patch file Download diff file Expand all files Collapse all files

48

Documentation/doc-guide/kernel-doc.rst

View file

15

include/media/v4l2-ioctl.h

View file

46

tools/lib/python/kdoc/kdoc_output.py

View file

79

tools/lib/python/kdoc/kdoc_parser.py

View file