[PATCH v3 0/5] Cleanup Linux Watchdog documentation

Philipp Hahn
2026-05-05T09:26:43Z

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 (5):
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

v2 -> v1
- Rename wdt.rst to ics-wdt.rst
- Expand abbreviation "ICS" in more places
- Fix wrong reference to samples/watchdog/watchdog-simple.c
v1 -> v2
- Drop invalid SPDX change to Documentation/watchdog/index.rst
- Add SPDX to Documentation/watchdog/wdt.rst

.../convert_drivers_to_kernel_api.rst | 28 +++++++++----------
.../watchdog/{wdt.rst => ics-wdt.rst} | 8 ++++--
Documentation/watchdog/index.rst | 20 +++++++++----
Documentation/watchdog/watchdog-api.rst | 4 +--
.../watchdog/watchdog-kernel-api.rst | 2 +-
drivers/watchdog/Kconfig | 10 ++++---
drivers/watchdog/smsc37b787_wdt.c | 2 +-
7 files changed, 44 insertions(+), 30 deletions(-)
rename Documentation/watchdog/{wdt.rst => ics-wdt.rst} (91%)

--
2.43.0