public inbox for linux-doc@vger.kernel.org
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Jonathan Corbet <corbet@lwn.net>,
	Mauro Carvalho Chehab <mchehab@kernel.org>
Cc: 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>,
	Sasha Levin <sashal@kernel.org>
Subject: Re: [PATCH 00/14] More kernel-doc patches
Date: Wed, 18 Mar 2026 10:43:21 +0100	[thread overview]
Message-ID: <20260318104321.53065c27@foz.lan> (raw)
In-Reply-To: <cover.1773823995.git.mchehab+huawei@kernel.org>

On Wed, 18 Mar 2026 10:11:00 +0100
Mauro Carvalho Chehab <mchehab+huawei@kernel.org> wrote:

> Hi Jon,
> 
> This series comes after:
>     https://lore.kernel.org/linux-doc/cover.1773770483.git.mchehab+huawei@kernel.org/
> 
> 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.

Btw, if one wants, for instance, to obtain all mm-related kAPI already
documented with kernel-doc markups in a machine-readable format, all 
it is needed is to run:

	$ ./scripts/kernel-doc -none -y mm.yaml mm/ include/linux/mm.h include/linux/mm_*.h

Its output follows the YAML schema defined at:

	tools/unittests/kdoc-test-schema.yaml

Regards,
Mauro

  parent reply	other threads:[~2026-03-18  9:43 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-03-18  9:11 [PATCH 00/14] More kernel-doc patches Mauro Carvalho Chehab
2026-03-18  9:11 ` [PATCH 01/14] unittests: test_tokenizer: better handle mismatch error Mauro Carvalho Chehab
2026-03-18  9:11 ` [PATCH 02/14] docs: kdoc_re: better represent long regular expressions Mauro Carvalho Chehab
2026-03-18  9:11 ` [PATCH 03/14] docs: kdoc: add c_lex to generated documentation Mauro Carvalho Chehab
2026-03-18  9:11 ` [PATCH 04/14] docs: kdoc_files: use a class to group config parameters Mauro Carvalho Chehab
2026-03-18  9:11 ` [PATCH 05/14] docs: kdoc_files: move output symbols logic to kdoc_output Mauro Carvalho Chehab
2026-03-18  9:11 ` [PATCH 06/14] docs: kdoc_item: fix initial value for parameterdesc_start_lines Mauro Carvalho Chehab
2026-03-18  9:11 ` [PATCH 07/14] docs: kdoc_item: add support to generate a KdocItem from a dict Mauro Carvalho Chehab
2026-03-18  9:11 ` [PATCH 08/14] docs: kdoc_item: fix a typo on sections_start_lines Mauro Carvalho Chehab
2026-03-18  9:11 ` [PATCH 09/14] docs: unittests: add a parser to test kernel-doc parser logic Mauro Carvalho Chehab
2026-03-18  9:11 ` [PATCH 10/14] docs: add a schema to help creating unittests for kernel-doc Mauro Carvalho Chehab
2026-03-18  9:11 ` [PATCH 11/14] docs: add a simple kdoc-test.yaml together with a validation tool Mauro Carvalho Chehab
2026-03-18  9:11 ` [PATCH 12/14] docs: test_kdoc_parser: add support for dynamic test creation Mauro Carvalho Chehab
2026-03-18  9:11 ` [PATCH 13/14] docs: add a new file to write kernel-doc output to a YAML file Mauro Carvalho Chehab
2026-03-18  9:11 ` [PATCH 14/14] docs: kernel-doc: add support to store output on " Mauro Carvalho Chehab
2026-03-18  9:43 ` Mauro Carvalho Chehab [this message]
2026-03-22 21:25 ` [PATCH 00/14] More kernel-doc patches Jonathan Corbet

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=20260318104321.53065c27@foz.lan \
    --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=sashal@kernel.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