public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
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 v3 0/5] Cleanup Linux Watchdog documentation
Date: Tue,  5 May 2026 11:26:11 +0200	[thread overview]
Message-ID: <cover.1777972790.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 (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


             reply	other threads:[~2026-05-05  9:26 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-05-05  9:26 Philipp Hahn [this message]
2026-05-05  9:26 ` [PATCH v3 1/5] watchdog: Change suffix .txt to .rst in references Philipp Hahn
2026-05-05 13:08   ` Guenter Roeck
2026-05-05  9:26 ` [PATCH v3 2/5] watchdog: Move `struct` before name Philipp Hahn
2026-05-05 13:09   ` Guenter Roeck
2026-05-05  9:26 ` [PATCH v3 3/5] watchdog: Replace intermixed tab/space indent Philipp Hahn
2026-05-05  9:26 ` [PATCH v3 4/5] watchdog: Separate kind of documentation Philipp Hahn
2026-05-05 13:11   ` Guenter Roeck
2026-05-05  9:26 ` [PATCH v3 5/5] watchdog: Prefix WDT with ICS for clarity Philipp Hahn
2026-05-05 13:12   ` 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.1777972790.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