Skip to content

minor changes at kernel-doc and a fix

Mauro Carvalho Chehab linux-doc lkml 1 version In review

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 Latest10 patches 1 replyIn review

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/10MAINTAINERS: update documentation scripts to add unittestsMAINTAINERS+2 -10 replies
2/10unittests: test_kdoc_parser: add command line arg to read a YAML filetools/unittests/test_kdoc_parser.py+20 -30 replies
3/10docs: tools: include kdoc_yaml_file at documentationDocumentation/tools/kdoc_ancillary.rst+8 -00 replies
4/10docs: kdoc_yaml_file: add a representer to make strings look nicertools/lib/python/kdoc/kdoc_yaml_file.py+15 -30 replies
5/10docs: kdoc-test.yaml: add more teststools/unittests/kdoc-test.yaml+1546 -20 replies
6/10docs: kdoc_output: fix handling of simple tablestools/lib/python/kdoc/kdoc_output.py+3 -30 replies
7/10docs: kdoc: better handle source when producing YAML outputtools/lib/python/kdoc/kdoc_files.py tools/lib/python/kdoc/kdoc_item.py tools/lib/python/kdoc/kdoc_parser.py +2 more+79 -721 reply
8/10docs: kdoc_yaml_file: use a better name for the teststools/lib/python/kdoc/kdoc_yaml_file.py+17 -60 replies
9/10docs: kdoc_output: raise an error if full_proto not available for vartools/lib/python/kdoc/kdoc_output.py+3 -10 replies
10/10docs: c_lex.py: store logger on its datatools/lib/python/kdoc/c_lex.py+7 -10 replies

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v1 yet.

Read the v1 thread

Cover letter [PATCH 00/10] minor changes at kernel-doc and a fix

Hi Jon,

Thanks for picking the other series. This one does minor changes at kernel-doc, focused on YAML input and adding more regression tests:

- adds an entry at MAINTAINERS for unittests;
- adds more parser tests for some corner cases;
- the YAML output is now using literals on all multi-line keys, making it a lot easier to handle it;
- the YAML output now uses better names;
- the YAML output can now output all tests. Previously, some bad-formatted kernel-doc tags caused it to give up adding some tests;
- added a check for a hidden problem at kdoc_output;
- improved logging when CTokenizer find issues.

After adding parser tests, I picked a bug on how simple tables are handled on man pages, fixed on this patch:

docs: kdoc_output: fix handling of simple tables
That's the only visible change at kdoc output and affects only man pages.

Mauro Carvalho Chehab (10):
MAINTAINERS: update documentation scripts to add unittests
unittests: test_kdoc_parser: add command line arg to read a YAML file
docs: tools: include kdoc_yaml_file at documentation
docs: kdoc_yaml_file: add a representer to make strings look nicer
docs: kdoc-test.yaml: add more tests
docs: kdoc_output: fix handling of simple tables
docs: kdoc: better handle source when producing YAML output
docs: kdoc_yaml_file: use a better name for the tests
docs: kdoc_output: raise an error if full_proto not available for var
docs: c_lex.py: store logger on its data

 Documentation/tools/kdoc_ancillary.rst  |    8 +
 MAINTAINERS                             |    3 +-
 tools/lib/python/kdoc/c_lex.py          |    8 +-
 tools/lib/python/kdoc/kdoc_files.py     |    8 +-
 tools/lib/python/kdoc/kdoc_item.py      |    6 +-
 tools/lib/python/kdoc/kdoc_output.py    |   10 +-
 tools/lib/python/kdoc/kdoc_parser.py    |  100 +-
 tools/lib/python/kdoc/kdoc_yaml_file.py |   67 +-
 tools/unittests/kdoc-test.yaml          | 1548 ++++++++++++++++++++++-
 tools/unittests/test_kdoc_parser.py     |   32 +-
 10 files changed, 1699 insertions(+), 91 deletions(-)
Signature · 1 line
2.53.0