From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: "Jonathan Corbet" <corbet@lwn.net>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
Stephen Rothwell <sfr@canb.auug.org.au>,
Nicolas Schier <nicolas.schier@linux.dev>,
Akira Yokosawa <akiyks@gmail.com>,
Randy Dunlap <rdunlap@infradead.org>,
Andy Shevchenko <andriy.shevchenko@linux.intel.com>,
linux-doc@vger.kernel.org, linux-kbuild@vger.kernel.org,
linux-kernel@vger.kernel.org
Subject: [PATCH 0/4] Some kernel-doc fixes
Date: Tue, 20 May 2025 15:33:05 +0200 [thread overview]
Message-ID: <cover.1747747695.git.mchehab+huawei@kernel.org> (raw)
Hi Jon,
Let me consolidate some patches on a single PR to make life simpler
for you. Those should address Stephen and Akira's concerns with
regards to KernelDoc class usage via sphinx kerneldoc.py extension.
Patch 1: don't let Sphinx suppress errors/warnings;
Patch 2: fix a KeyError when trying to acess data from non-existing files;
Patch 3: add try/except blocks to avoid crashes when handling bad
kernel-doc markups;
Patch 4: makes Lore and kernel-doc ML receive patches related
to kernel-doc.py and get_abi.py.
Patches 1 to 3 were already submitted on separate series. Patch 4 is new.
Regards,
Mauro
Mauro Carvalho Chehab (4):
docs: kerneldoc.py: don't use Sphinx logger
scripts: kernel-doc: prevent a KeyError when checking output
docs: kerneldoc.py: add try/except blocks for kernel-doc class errors
MAINTAINERS: update linux-doc entry to cover new Python scripts
Documentation/sphinx/kerneldoc.py | 27 ++++++++++++++++++++++-----
MAINTAINERS | 5 ++++-
scripts/lib/kdoc/kdoc_files.py | 4 ++++
3 files changed, 30 insertions(+), 6 deletions(-)
--
2.49.0
next reply other threads:[~2025-05-20 13:33 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-05-20 13:33 Mauro Carvalho Chehab [this message]
2025-05-20 13:33 ` [PATCH 1/4] docs: kerneldoc.py: don't use Sphinx logger Mauro Carvalho Chehab
2025-05-20 13:33 ` [PATCH 2/4] scripts: kernel-doc: prevent a KeyError when checking output Mauro Carvalho Chehab
2025-05-20 13:33 ` [PATCH 3/4] docs: kerneldoc.py: add try/except blocks for kernel-doc class errors Mauro Carvalho Chehab
2025-05-20 14:22 ` Andy Shevchenko
2025-05-20 14:50 ` Mauro Carvalho Chehab
2025-05-20 15:40 ` Mauro Carvalho Chehab
2025-05-20 13:33 ` [PATCH 4/4] MAINTAINERS: update linux-doc entry to cover new Python scripts Mauro Carvalho Chehab
2025-05-20 14:17 ` [PATCH 0/4] Some kernel-doc fixes Andy Shevchenko
2025-05-20 14:31 ` 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.1747747695.git.mchehab+huawei@kernel.org \
--to=mchehab+huawei@kernel.org \
--cc=akiyks@gmail.com \
--cc=andriy.shevchenko@linux.intel.com \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kbuild@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=nicolas.schier@linux.dev \
--cc=rdunlap@infradead.org \
--cc=sfr@canb.auug.org.au \
/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;
as well as URLs for NNTP newsgroup(s).