Re: [PATCH v2] Documentation: Refactored watchdog old doc

From: Randy Dunlap

Date: Sat Apr 11 2026 - 13:23:07 EST




On 4/11/26 8:09 AM, Sunny Patel wrote:
> Mark WDIOC_GETTEMP and WDIOS_TEMPPANIC as deprecated since
> neither is implemented by the watchdog core and both are only
> present in a small number of legacy drivers.
>
> Add documentation for previously undocumented status bits
> WDIOF_MAGICCLOSE and WDIOF_ALARMONLY in the options field.
>
> Add documentation for WDIOF_PRETIMEOUT and WDIOF_SETTIMEOUT
> status bits describing their respective ioctls.
>
> Fix the following issues in existing documentation:
> - Remove version-specific reference to Linux 2.4.18 from
> the GETTIMEOUT ioctl description
> - Fix duplicate "was is" in printf format strings
> - Replace [FIXME] placeholder with proper descriptions for
> WDIOS_DISABLECARD, WDIOS_ENABLECARD and WDIOS_TEMPPANIC
>
> Signed-off-by: Sunny Patel <nueralspacetech@xxxxxxxxx>
> ---
>
> Changes in v2:
> - Fixed typos: "tiemout" -> "timeout", "characted" -> "character"
> - Fixed "small number if legacy" -> "of legacy"
> - Fixed capitalization: "New Drivers" -> "New drivers", "USE" -> "Use"
> - Fixed spacing: "WDIOS_DISABLECARD,this" -> "WDIOS_DISABLECARD, this"
> - Fixed double spaces in two places
> - Added missing newline at end of file
> - Rewrote commit message

However, you failed to fix a malformed table warning that I reported here:
https://lore.kernel.org/linux-doc/9e3403a0-4ec2-4fbe-a50f-53f939c1d841@xxxxxxxxxxxxx/

Documentation/watchdog/watchdog-api.rst:250: ERROR: Malformed table.
Text in column margin in table line 2.

================ ================================
WDIOF_ALARMONLY Not a reboot watchdog
================ ================================


So I repeat, please test your patches.

>
> Documentation/watchdog/watchdog-api.rst | 59 +++++++++++++++++++++----
> 1 file changed, 51 insertions(+), 8 deletions(-)
--
~Randy