Skip to content

Cleanup Linux Watchdog documentation

Philipp Hahn linux-doc linux-watchdog lkml 3 versions – Applied

Status from this message: Applied to my watchdog-next branch.

Get series with b4
b4 am [email protected]

Versions newest first · linked by author and title

  1. v3 Latest5 patches 4 repliesApplied
  2. v25 patches 1 replySuperseded
  3. v16 patches 4 repliesSuperseded

v2 -> v1 from the cover letter

- Rename wdt.rst to ics-wdt.rst
- Expand abbreviation "ICS" in more places
- Fix wrong reference to samples/watchdog/watchdog-simple.c

Patches in v3 Applied

#Subject and filesSizeRepliesApplied
1/5watchdog: Change suffix .txt to .rst in referencesDocumentation/watchdog/convert_drivers_to_kernel_api.rst+2 -21 reply
2/5watchdog: Move `struct` before nameDocumentation/watchdog/convert_drivers_to_kernel_api.rst Documentation/watchdog/watchdog-api.rst Documentation/watchdog/watchdog-kernel-api.rst+14 -141 reply
3/5watchdog: Replace intermixed tab/space indentDocumentation/watchdog/watchdog-api.rst+1 -10 replies
4/5watchdog: Separate kind of documentationDocumentation/watchdog/index.rst+15 -51 reply
5/5watchdog: Prefix WDT with ICS for clarityDocumentation/watchdog/ics-wdt.rst Documentation/watchdog/index.rst drivers/watchdog/Kconfig +1 more+13 -91 reply

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v3 yet.

Read the v3 thread

Cover letter [PATCH v3 0/5] Cleanup Linux Watchdog documentation

From: Philipp Hahn <[email protected]>

Hello,

while reading the documentation on the Linux kernel watchdog subsystem[1] I noticed some strange looking formatting: structs 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%)
Signature · 1 line
2.43.0