From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Jonathan Corbet <corbet@lwn.net>
Cc: "Mauro Carvalho Chehab" <mchehab+huawei@kernel.org>,
"Alex Shi" <alexs@kernel.org>,
"Carlos Bilbao" <carlos.bilbao@kernel.org>,
"David Airlie" <airlied@gmail.com>,
"Federico Vaga" <federico.vaga@vaga.pv.it>,
"Hu Haowen" <2023002089@link.tyut.edu.cn>,
"Jani Nikula" <jani.nikula@linux.intel.com>,
"Joonas Lahtinen" <joonas.lahtinen@linux.intel.com>,
"Mauro Carvalho Chehab" <mchehab@kernel.org>,
"Nathan Chancellor" <nathan@kernel.org>,
"Nicolas Schier" <nsc@kernel.org>,
"Rodrigo Vivi" <rodrigo.vivi@intel.com>,
"Simona Vetter" <simona@ffwll.ch>,
"Tvrtko Ursulin" <tursulin@ursulin.net>,
"Yanteng Si" <si.yanteng@linux.dev>,
dri-devel@lists.freedesktop.org, intel-gfx@lists.freedesktop.org,
linux-doc@vger.kernel.org, linux-kbuild@vger.kernel.org,
linux-kernel@vger.kernel.org, workflows@vger.kernel.org,
"Thomas Weißschuh" <thomas.weissschuh@linutronix.de>,
"Andy Shevchenko" <andriy.shevchenko@linux.intel.com>,
"Avadhut Naik" <avadhut.naik@amd.com>,
"Chenguang Zhao" <zhaochenguang@kylinos.cn>,
"David Disseldorp" <ddiss@suse.de>,
"Dongliang Mu" <dzm91@hust.edu.cn>,
"Gang Yan" <yangang@kylinos.cn>, "Kees Cook" <kees@kernel.org>,
"Masahiro Yamada" <masahiroy@kernel.org>,
"Miguel Ojeda" <ojeda@kernel.org>,
"Randy Dunlap" <rdunlap@infradead.org>,
"Shuah Khan" <skhan@linuxfoundation.org>,
"Steven Rostedt" <rostedt@goodmis.org>,
"Tamir Duberstein" <tamird@gmail.com>,
"Vincent Mailhol" <mailhol@kernel.org>,
WangYuli <wanyl5933@chinaunicom.cn>
Subject: [PATCH 0/9] docs: Fix kernel-doc -Werror and moves it to tools/docs
Date: Mon, 19 Jan 2026 13:04:55 +0100 [thread overview]
Message-ID: <cover.1768823489.git.mchehab+huawei@kernel.org> (raw)
Hi Jon,
After a restful weekend and revisiting both yours and my series,
I'm opting to send a patch series merging both into one:
- The first 4 patches are from my series (no changes since v5):
https://lore.kernel.org/linux-doc/cover.1768642102.git.mchehab+huawei@kernel.org/T/#m81211c0ff38bbaa82b8b0b6606f242ccc0c2a9ac
- It follows by the 2 patches from your renaming series:
https://lore.kernel.org/linux-doc/20260119111745.4694546b@foz.lan/T/#m51099c31a99dccccdb4d17cbaadc818e9e4df8c4
with the fix I proposed for kernel-doc to find its libraries
I added 3 patches afterwards:
- patch 5: move possible return values from docstring to helper message;
- patch 6: improve MsgFormatter description;
- patch 7: moves kerneldoc_bin from conf.py to the sphinx/kerneldoc.py
(this is now just a debugging message - no need to pick it from env)
IMO, this series is ready to be merged.
NOTE:
I didn't rename kernel-doc to kernel_doc.py nor added any symlinks.
If we want some day to use sphinx autoparse extension, we can do it
later. I guess we can also revisit it during -rc period, if needed.
Regards,
Mauro
Jonathan Corbet (2):
docs: kdoc: remove support for an external kernel-doc from sphinx
docs: kdoc: move kernel-doc to tools/docs
Mauro Carvalho Chehab (7):
docs: kdoc: fix logic to handle unissued warnings
docs: kdoc: avoid error_count overflows
docs: kdoc: ensure that comments are using our coding style
docs: kdoc: some fixes to kernel-doc comments
docs: kdoc: move the return values to the helper message
docs: kdoc: improve description of MsgFormatter
docs: conf.py: get rid of the now unused kerneldoc_bin env var
Documentation/conf.py | 4 -
Documentation/doc-guide/kernel-doc.rst | 8 +-
Documentation/kbuild/kbuild.rst | 2 +-
Documentation/process/coding-style.rst | 2 +-
Documentation/sphinx/kerneldoc.py | 60 +++----------
.../it_IT/doc-guide/kernel-doc.rst | 8 +-
.../sp_SP/process/coding-style.rst | 2 +-
.../zh_CN/doc-guide/kernel-doc.rst | 10 +--
.../translations/zh_CN/kbuild/kbuild.rst | 2 +-
.../zh_CN/process/coding-style.rst | 2 +-
.../zh_TW/process/coding-style.rst | 2 +-
MAINTAINERS | 2 -
Makefile | 2 +-
drivers/gpu/drm/i915/Makefile | 2 +-
scripts/kernel-doc | 1 -
tools/docs/find-unused-docs.sh | 2 +-
.../kernel-doc.py => tools/docs/kernel-doc | 89 ++++++++++++-------
tools/docs/sphinx-build-wrapper | 2 +-
tools/lib/python/kdoc/kdoc_parser.py | 35 ++++++--
19 files changed, 120 insertions(+), 117 deletions(-)
delete mode 120000 scripts/kernel-doc
rename scripts/kernel-doc.py => tools/docs/kernel-doc (88%)
--
2.52.0
next reply other threads:[~2026-01-19 12:05 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-01-19 12:04 Mauro Carvalho Chehab [this message]
2026-01-19 12:04 ` [PATCH 1/9] docs: kdoc: fix logic to handle unissued warnings Mauro Carvalho Chehab
2026-01-19 12:04 ` [PATCH 2/9] docs: kdoc: avoid error_count overflows Mauro Carvalho Chehab
2026-01-19 12:04 ` [PATCH 3/9] docs: kdoc: ensure that comments are using our coding style Mauro Carvalho Chehab
2026-01-19 12:04 ` [PATCH 4/9] docs: kdoc: some fixes to kernel-doc comments Mauro Carvalho Chehab
2026-01-19 12:05 ` [PATCH 5/9] docs: kdoc: remove support for an external kernel-doc from sphinx Mauro Carvalho Chehab
2026-01-19 12:05 ` [PATCH 6/9] docs: kdoc: move kernel-doc to tools/docs Mauro Carvalho Chehab
2026-01-19 12:05 ` [PATCH 7/9] docs: kdoc: move the return values to the helper message Mauro Carvalho Chehab
2026-01-19 12:05 ` [PATCH 8/9] docs: kdoc: improve description of MsgFormatter Mauro Carvalho Chehab
2026-01-19 12:05 ` [PATCH 9/9] docs: conf.py: get rid of the now unused kerneldoc_bin env var Mauro Carvalho Chehab
2026-01-20 22:56 ` [PATCH 0/9] docs: Fix kernel-doc -Werror and moves it to tools/docs Jonathan Corbet
2026-01-20 23:00 ` 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.1768823489.git.mchehab+huawei@kernel.org \
--to=mchehab+huawei@kernel.org \
--cc=2023002089@link.tyut.edu.cn \
--cc=airlied@gmail.com \
--cc=alexs@kernel.org \
--cc=andriy.shevchenko@linux.intel.com \
--cc=avadhut.naik@amd.com \
--cc=carlos.bilbao@kernel.org \
--cc=corbet@lwn.net \
--cc=ddiss@suse.de \
--cc=dri-devel@lists.freedesktop.org \
--cc=dzm91@hust.edu.cn \
--cc=federico.vaga@vaga.pv.it \
--cc=intel-gfx@lists.freedesktop.org \
--cc=jani.nikula@linux.intel.com \
--cc=joonas.lahtinen@linux.intel.com \
--cc=kees@kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kbuild@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mailhol@kernel.org \
--cc=masahiroy@kernel.org \
--cc=mchehab@kernel.org \
--cc=nathan@kernel.org \
--cc=nsc@kernel.org \
--cc=ojeda@kernel.org \
--cc=rdunlap@infradead.org \
--cc=rodrigo.vivi@intel.com \
--cc=rostedt@goodmis.org \
--cc=si.yanteng@linux.dev \
--cc=simona@ffwll.ch \
--cc=skhan@linuxfoundation.org \
--cc=tamird@gmail.com \
--cc=thomas.weissschuh@linutronix.de \
--cc=tursulin@ursulin.net \
--cc=wanyl5933@chinaunicom.cn \
--cc=workflows@vger.kernel.org \
--cc=yangang@kylinos.cn \
--cc=zhaochenguang@kylinos.cn \
/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