From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Jonathan Corbet <corbet@lwn.net>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
Akira Yokosawa <akiyks@gmail.com>,
linux-doc@vger.kernel.org,
Masahiro Yamada <mchehab+huawei@kernel.org>,
Nathan Chancellor <mchehab+huawei@kernel.org>,
Nicolas Schier <nicolas.schier@linux.dev>,
Andy Shevchenko <andriy.shevchenko@linux.intel.com>,
Stephen Rothwell <sfr@canb.auug.org.au>,
Randy Dunlap <rdunlap@infradead.org>,
linux-kbuild@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: [PATCH v2 0/3] Some kernel-doc fixes
Date: Wed, 21 May 2025 08:59:30 +0200 [thread overview]
Message-ID: <cover.1747810691.git.mchehab+huawei@kernel.org> (raw)
Hi Jon,
That's the second version of the kernel-doc fixup patch series.
I discovered the root cause why Sphinx logger was not working: there
was a call there for logger.verbose(). According with:
https://www.sphinx-doc.org/en/master/extdev/logging.html
This is a valid call, but it doesn't verbose messages. Instead, it is
crashing with modern Sphinx versions, causing the log to not work.
I got rid of it, replacing by logger.info(). I took the time to also
address an issue pointed by Andy: not having the same log message
placed everywhere. With such change, we can keep using Sphinx
logger (which produces colored messages) inside kernel-doc
classes.
With that, we have:
Patch 1: makes Lore and kernel-doc ML receive patches related
to kernel-doc.py and get_abi.py.
Patch 2: cleanup try/except logic and get rid of logger.verbose();
Patch 3: fix a KeyError when trying to acess data from non-existing files;
If you test just patch 1 on the top of next-20250516, you'll see the
keyerror message (in red):
ERROR: Cannot find file ./drivers/gpio/gpiolib-acpi.c
ERROR: Cannot find file ./drivers/gpio/gpiolib-acpi.c
WARNING: kernel-doc './scripts/kernel-doc.py -rst -enable-lineno -export ./drivers/gpio/gpiolib-acpi.c' processing failed with: KeyError('./drivers/gpio/gpiolib-acpi.c')
And the script doesn't crash anymore. After patch 2, the try/except
warning gets replaced by a proper message:
ERROR: Cannot find file ./drivers/gpio/gpiolib-acpi.c
ERROR: Cannot find file ./drivers/gpio/gpiolib-acpi.c
WARNING: No kernel-doc for file ./drivers/gpio/gpiolib-acpi.c
Please apply it to solve the issues that are reported by Stephen and Akira.
Regards,
Mauro
Mauro Carvalho Chehab (3):
MAINTAINERS: update linux-doc entry to cover new Python scripts
docs: kerneldoc.py: simplify exception handling logic
scripts: kernel-doc: prevent a KeyError when checking output
Documentation/sphinx/kerneldoc.py | 108 +++++++++++++-----------------
MAINTAINERS | 5 +-
scripts/lib/kdoc/kdoc_files.py | 4 ++
3 files changed, 53 insertions(+), 64 deletions(-)
--
2.49.0
next reply other threads:[~2025-05-21 6:59 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-05-21 6:59 Mauro Carvalho Chehab [this message]
2025-05-21 6:59 ` [PATCH v2 1/3] MAINTAINERS: update linux-doc entry to cover new Python scripts Mauro Carvalho Chehab
2025-05-21 8:21 ` Akira Yokosawa
2025-05-21 6:59 ` [PATCH v2 2/3] docs: kerneldoc.py: simplify exception handling logic Mauro Carvalho Chehab
2025-05-21 6:59 ` [PATCH v2 3/3] scripts: kernel-doc: prevent a KeyError when checking output Mauro Carvalho Chehab
2025-05-21 8:30 ` [PATCH v2 0/3] Some kernel-doc fixes Akira Yokosawa
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.1747810691.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).