From: Philipp Hahn <p.hahn@avm.de>
To: Wim Van Sebroeck <wim@linux-watchdog.org>,
Guenter Roeck <linux@roeck-us.net>
Cc: Philipp Hahn <phahn-oss@avm.de>,
linux-watchdog@vger.kernel.org, linux-doc@vger.kernel.org,
linux-kernel@vger.kernel.org
Subject: [PATCH 0/6] Cleanup Linux Watchdog documentation
Date: Mon, 4 May 2026 13:02:35 +0200 [thread overview]
Message-ID: <cover.1777892508.git.phahn-oss@avm.de> (raw)
From: Philipp Hahn <phahn-oss@avm.de>
Hello,
while reading the documentation on the Linux kernel watchdog
subsystem[1] I noticed some strange looking formatting: `struct`s are
detected automatically by Sphinx and the word **after** it is considered
the name of the structure, but the watchdog documentation puts the name
**before** the word `struct`; this leads to the wrong word being
emphasized.
Also reorganize the index page to better separate the documentation on
generic infrastructure from specific drivers – which are mostly obsolete
and relevant for historic documentation only.
Please apply; thank you for all your work.
Philipp
[1]: https://docs.kernel.org/watchdog/convert_drivers_to_kernel_api.html
Philipp Hahn (6):
watchdog: Fix wrong SPDX license identifier
watchdog: Change suffix .txt to .rst in references
watchdog: Move `struct` before name
watchdog: Replace intermixed tab/space indent
watchdog: Separate kind of documentation
watchdog: Prefix WDT with ICS for clarity
.../convert_drivers_to_kernel_api.rst | 28 +++++++++----------
Documentation/watchdog/index.rst | 22 +++++++++++----
Documentation/watchdog/watchdog-api.rst | 4 +--
.../watchdog/watchdog-kernel-api.rst | 2 +-
Documentation/watchdog/wdt.rst | 6 ++--
drivers/watchdog/Kconfig | 6 ++--
6 files changed, 39 insertions(+), 29 deletions(-)
--
2.43.0
next reply other threads:[~2026-05-04 11:08 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-05-04 11:02 Philipp Hahn [this message]
2026-05-04 11:02 ` [PATCH 1/6] watchdog: Fix wrong SPDX license identifier Philipp Hahn
2026-05-04 11:02 ` [PATCH 2/6] watchdog: Change suffix .txt to .rst in references Philipp Hahn
2026-05-04 11:02 ` [PATCH 3/6] watchdog: Move `struct` before name Philipp Hahn
2026-05-04 11:02 ` [PATCH 4/6] watchdog: Replace intermixed tab/space indent Philipp Hahn
2026-05-04 11:02 ` [PATCH 5/6] watchdog: Separate kind of documentation Philipp Hahn
2026-05-04 11:02 ` [PATCH 6/6] watchdog: Prefix WDT with ICS for clarity Philipp Hahn
2026-05-04 14:00 ` Guenter Roeck
2026-05-04 13:49 ` [PATCH v2 0/5] Cleanup Linux Watchdog documentation Philipp Hahn
2026-05-04 13:49 ` [PATCH v2 1/5] watchdog: Change suffix .txt to .rst in references Philipp Hahn
2026-05-04 13:50 ` [PATCH v2 2/5] watchdog: Move `struct` before name Philipp Hahn
2026-05-04 13:50 ` [PATCH v2 3/5] watchdog: Replace intermixed tab/space indent Philipp Hahn
2026-05-04 13:50 ` [PATCH v2 4/5] watchdog: Separate kind of documentation Philipp Hahn
2026-05-04 13:50 ` [PATCH v2 5/5] watchdog: Prefix WDT with ICS for clarity Philipp Hahn
2026-05-04 14:11 ` [PATCH v2 0/5] Cleanup Linux Watchdog documentation Guenter Roeck
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.1777892508.git.phahn-oss@avm.de \
--to=p.hahn@avm.de \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-watchdog@vger.kernel.org \
--cc=linux@roeck-us.net \
--cc=phahn-oss@avm.de \
--cc=wim@linux-watchdog.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