From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Jonathan Corbet <corbet@lwn.net>,
Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
linux-kernel@vger.kernel.org,
Mauro Carvalho Chehab <mchehab@kernel.org>,
Shuah Khan <skhan@linuxfoundation.org>
Subject: [PATCH 03/10] docs: tools: include kdoc_yaml_file at documentation
Date: Mon, 23 Mar 2026 10:10:46 +0100 [thread overview]
Message-ID: <32b86abe7acee2dd4f73a35836ec94e8690f04cd.1774256269.git.mchehab+huawei@kernel.org> (raw)
In-Reply-To: <cover.1774256269.git.mchehab+huawei@kernel.org>
Add an autodoc entry for the new kdoc_yaml_file module.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
Documentation/tools/kdoc_ancillary.rst | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/Documentation/tools/kdoc_ancillary.rst b/Documentation/tools/kdoc_ancillary.rst
index 85f3806a431a..249753744d11 100644
--- a/Documentation/tools/kdoc_ancillary.rst
+++ b/Documentation/tools/kdoc_ancillary.rst
@@ -53,3 +53,11 @@ Python version ancillary methods
:members:
:show-inheritance:
:undoc-members:
+
+Write output on YAML file
+=========================
+
+.. automodule:: lib.python.kdoc.kdoc_yaml_file
+ :members:
+ :show-inheritance:
+ :undoc-members:
--
2.53.0
next prev parent 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 [PATCH 00/10] minor changes at kernel-doc and a fix Mauro Carvalho Chehab
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 ` Mauro Carvalho Chehab [this message]
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=32b86abe7acee2dd4f73a35836ec94e8690f04cd.1774256269.git.mchehab+huawei@kernel.org \
--to=mchehab+huawei@kernel.org \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mchehab@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
all inboxes | Powered by JetHome®