Skip to content

More kernel-doc patches

Mauro Carvalho Chehab linux-doc lkml 1 version In review

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 Latest14 patches 2 repliesIn review

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/14unittests: test_tokenizer: better handle mismatch errortools/unittests/test_tokenizer.py+10 -30 replies
2/14docs: kdoc_re: better represent long regular expressionstools/lib/python/kdoc/kdoc_re.py+7 -20 replies
3/14docs: kdoc: add c_lex to generated documentationDocumentation/tools/kdoc_ancillary.rst tools/lib/python/kdoc/c_lex.py+14 -40 replies
4/14docs: kdoc_files: use a class to group config parameterstools/lib/python/kdoc/kdoc_files.py+31 -140 replies
5/14docs: kdoc_files: move output symbols logic to kdoc_outputtools/lib/python/kdoc/kdoc_files.py tools/lib/python/kdoc/kdoc_output.py+23 -160 replies
6/14docs: kdoc_item: fix initial value for parameterdesc_start_linestools/lib/python/kdoc/kdoc_item.py+1 -10 replies
7/14docs: kdoc_item: add support to generate a KdocItem from a dicttools/lib/python/kdoc/kdoc_item.py+34 -10 replies
8/14docs: kdoc_item: fix a typo on sections_start_linestools/lib/python/kdoc/kdoc_item.py tools/lib/python/kdoc/kdoc_output.py tools/lib/python/kdoc/kdoc_parser.py+5 -50 replies
9/14docs: unittests: add a parser to test kernel-doc parser logictools/unittests/test_kdoc_parser.py+202 -00 replies
10/14docs: add a schema to help creating unittests for kernel-doctools/unittests/kdoc-test-schema.yaml+156 -00 replies
11/14docs: add a simple kdoc-test.yaml together with a validation tooltools/unittests/kdoc-test.yaml tools/unittests/test_kdoc_test_schema.py+248 -00 replies
12/14docs: test_kdoc_parser: add support for dynamic test creationtools/unittests/test_kdoc_parser.py+350 -180 replies
13/14docs: add a new file to write kernel-doc output to a YAML filetools/lib/python/kdoc/kdoc_yaml_file.py+155 -00 replies
14/14docs: kernel-doc: add support to store output on a YAML filetools/docs/kernel-doc tools/lib/python/kdoc/kdoc_files.py tools/lib/python/kdoc/kdoc_parser.py+107 -150 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/14] More kernel-doc patches

Hi Jon,

This series comes after:

    https://lore.kernel.org/linux-doc/[email protected]/

It basically contains patches I submitted before on a 40+ patch series, but were less relevant, plus a couple of other minor fixes:

- patch 1 improves one of the CTokenizer unit test, fixing some potential issues on it;
- patches 2 and 3 contain some improvement/fixes for Sphinx Python autodoc extension. They basically document c_lex.py;

- The remaining patches:
- create a new class for kernel-doc config;
- fix some internal representations of KdocItem;
- add unit tests for KernelDoc() parser class;
- add support to output KdocItem in YAML, which is a machine-readable output for all documented kAPI.

None of the patches should affect man or html output.

Before you complain about the diffstats, changes at kdoc itself aren't big:

 tools/lib/python/kdoc/c_lex.py          |    9 +-
 tools/lib/python/kdoc/kdoc_files.py     |  104 ++++++++++++++++--------
 tools/lib/python/kdoc/kdoc_item.py      |   39 ++++++++-
 tools/lib/python/kdoc/kdoc_output.py    |   23 +++++
 tools/lib/python/kdoc/kdoc_parser.py    |   33 ++++++-
 tools/lib/python/kdoc/kdoc_re.py        |    9 +-
 tools/lib/python/kdoc/kdoc_yaml_file.py |  155 ++++++++++++++++++++++++++++++++++++
 7 files changed, 325 insertions(+), 47 deletions(-)

e.g. 155 new LoC for the new yaml file output and 123 new LoC for the other cleanups/fixes.

The remaining ones are at the YAML files and at unittests.

Mauro Carvalho Chehab (14):
unittests: test_tokenizer: better handle mismatch error
docs: kdoc_re: better represent long regular expressions
docs: kdoc: add c_lex to generated documentation
docs: kdoc_files: use a class to group config parameters
docs: kdoc_files: move output symbols logic to kdoc_output
docs: kdoc_item: fix initial value for parameterdesc_start_lines
docs: kdoc_item: add support to generate a KdocItem from a dict
docs: kdoc_item: fix a typo on sections_start_lines
docs: unittests: add a parser to test kernel-doc parser logic
docs: add a schema to help creating unittests for kernel-doc
docs: add a simple kdoc-test.yaml together with a validation tool
docs: test_kdoc_parser: add support for dynamic test creation
docs: add a new file to write kernel-doc output to a YAML file
docs: kernel-doc: add support to store output on a YAML file

 Documentation/tools/kdoc_ancillary.rst   |   9 +
 tools/docs/kernel-doc                    |  48 +-
 tools/lib/python/kdoc/c_lex.py           |   9 +-
 tools/lib/python/kdoc/kdoc_files.py      | 104 +++--
 tools/lib/python/kdoc/kdoc_item.py       |  39 +-
 tools/lib/python/kdoc/kdoc_output.py     |  23 +-
 tools/lib/python/kdoc/kdoc_parser.py     |  33 +-
 tools/lib/python/kdoc/kdoc_re.py         |   9 +-
 tools/lib/python/kdoc/kdoc_yaml_file.py  | 155 +++++++
 tools/unittests/kdoc-test-schema.yaml    | 156 +++++++
 tools/unittests/kdoc-test.yaml           | 154 +++++++
 tools/unittests/test_kdoc_parser.py      | 534 +++++++++++++++++++++++
 tools/unittests/test_kdoc_test_schema.py |  94 ++++
 tools/unittests/test_tokenizer.py        |  13 +-
 14 files changed, 1322 insertions(+), 58 deletions(-)
 create mode 100644 tools/lib/python/kdoc/kdoc_yaml_file.py
 create mode 100644 tools/unittests/kdoc-test-schema.yaml
 create mode 100644 tools/unittests/kdoc-test.yaml
 create mode 100755 tools/unittests/test_kdoc_parser.py
 create mode 100755 tools/unittests/test_kdoc_test_schema.py
Signature · 1 line
2.53.0