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

Mauro Carvalho Chehab posted 10 patches 1 week, 4 days ago
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(-)
[PATCH 00/10] minor changes at kernel-doc and a fix
Posted by Mauro Carvalho Chehab 1 week, 4 days ago
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(-)

-- 
2.53.0