From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Jonathan Corbet <corbet@lwn.net>,
Mauro Carvalho Chehab <mchehab@kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
Aleksandr Loktionov <aleksandr.loktionov@intel.com>,
Randy Dunlap <rdunlap@infradead.org>,
Shuah Khan <skhan@linuxfoundation.org>
Subject: [PATCH 00/10] minor changes at kernel-doc and a fix
Date: Mon, 23 Mar 2026 10:10:43 +0100 [thread overview]
Message-ID: <cover.1774256269.git.mchehab+huawei@kernel.org> (raw)
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
next reply other threads:[~2026-03-23 9:10 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-03-23 9:10 Mauro Carvalho Chehab [this message]
2026-03-23 9:10 ` [PATCH 01/10] MAINTAINERS: update documentation scripts to add unittests Mauro Carvalho Chehab
2026-03-23 9:10 ` [PATCH 02/10] unittests: test_kdoc_parser: add command line arg to read a YAML file Mauro Carvalho Chehab
2026-03-23 9:10 ` [PATCH 03/10] docs: tools: include kdoc_yaml_file at documentation Mauro Carvalho Chehab
2026-03-23 9:10 ` [PATCH 04/10] docs: kdoc_yaml_file: add a representer to make strings look nicer Mauro Carvalho Chehab
2026-03-23 9:10 ` [PATCH 05/10] docs: kdoc-test.yaml: add more tests Mauro Carvalho Chehab
2026-03-23 9:10 ` [PATCH 06/10] docs: kdoc_output: fix handling of simple tables Mauro Carvalho Chehab
2026-03-23 9:10 ` [PATCH 07/10] docs: kdoc: better handle source when producing YAML output Mauro Carvalho Chehab
2026-03-23 11:15 ` Loktionov, Aleksandr
2026-03-23 9:10 ` [PATCH 08/10] docs: kdoc_yaml_file: use a better name for the tests Mauro Carvalho Chehab
2026-03-23 9:10 ` [PATCH 09/10] docs: kdoc_output: raise an error if full_proto not available for var Mauro Carvalho Chehab
2026-03-23 9:10 ` [PATCH 10/10] docs: c_lex.py: store logger on its data Mauro Carvalho Chehab
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=cover.1774256269.git.mchehab+huawei@kernel.org \
--to=mchehab+huawei@kernel.org \
--cc=aleksandr.loktionov@intel.com \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mchehab@kernel.org \
--cc=rdunlap@infradead.org \
--cc=skhan@linuxfoundation.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox