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

v1 -> 2
  - Drop invalid SPDX change to Documentation/watchdog/index.rst
  - Add SPDX to Documentation/watchdog/wdt.rst

 .../convert_drivers_to_kernel_api.rst         | 28 +++++++++----------
 Documentation/watchdog/index.rst              | 20 +++++++++----
 Documentation/watchdog/watchdog-api.rst       |  4 +--
 .../watchdog/watchdog-kernel-api.rst          |  2 +-
 Documentation/watchdog/wdt.rst                |  8 ++++--
 drivers/watchdog/Kconfig                      |  6 ++--
 6 files changed, 40 insertions(+), 28 deletions(-)

-- 
2.43.0

On 5/4/26 06:49, Philipp Hahn wrote:
> 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

 From Documentation/process/submitting-patches.rst:

   However, for a multi-patch series, it is generally
   best to avoid using In-Reply-To: to link to older versions of the
   series.  This way multiple versions of the patch don't become an
   unmanageable forest of references in email clients.

... but you did that anyway. It also almost guarantees that new
versions of a patch series get lost.

Guenter