public inbox for linux-doc@vger.kernel.org
 help / color / mirror / Atom feed
* [PATCH 0/5] docs: watchdog: general cleaning and corrections
@ 2026-02-28  1:03 Randy Dunlap
  2026-02-28  1:03 ` [PATCH 1/5] docs: watchdog: mlx-wdt: small fixes Randy Dunlap
                   ` (5 more replies)
  0 siblings, 6 replies; 13+ messages in thread
From: Randy Dunlap @ 2026-02-28  1:03 UTC (permalink / raw)
  To: linux-kernel
  Cc: Randy Dunlap, Jonathan Corbet, Shuah Khan, Wim Van Sebroeck,
	Guenter Roeck, linux-watchdog, linux-doc

Fix some obvious issues in the watchdog documentation files.
I didn't try to fix every little niggling mistake.

 [PATCH 1/5] docs: watchdog: mlx-wdt: small fixes
 [PATCH 2/5] docs: watchdog: pcwd: fix typo and driver info.
 [PATCH 3/5] docs: watchdog-api: general cleaning
 [PATCH 4/5] docs: watchdog-kernel-api: general cleanups
 [PATCH 5/5] docs: watchdog-parameters: add missing watchdog_core parameters

 Documentation/watchdog/mlx-wdt.rst             |    4 -
 Documentation/watchdog/pcwd-watchdog.rst       |   19 +++++--
 Documentation/watchdog/watchdog-api.rst        |   38 +++++++--------
 Documentation/watchdog/watchdog-kernel-api.rst |   20 +++++--
 Documentation/watchdog/watchdog-parameters.rst |   11 +++-
 5 files changed, 58 insertions(+), 34 deletions(-)

Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Shuah Khan <skhan@linuxfoundation.org>
Cc: Wim Van Sebroeck <wim@linux-watchdog.org>
Cc: Guenter Roeck <linux@roeck-us.net>
Cc: linux-watchdog@vger.kernel.org
Cc: linux-doc@vger.kernel.org

^ permalink raw reply	[flat|nested] 13+ messages in thread

* [PATCH 1/5] docs: watchdog: mlx-wdt: small fixes
  2026-02-28  1:03 [PATCH 0/5] docs: watchdog: general cleaning and corrections Randy Dunlap
@ 2026-02-28  1:03 ` Randy Dunlap
  2026-02-28  1:51   ` Guenter Roeck
  2026-02-28  1:03 ` [PATCH 2/5] docs: watchdog: pcwd: fix typo and driver info Randy Dunlap
                   ` (4 subsequent siblings)
  5 siblings, 1 reply; 13+ messages in thread
From: Randy Dunlap @ 2026-02-28  1:03 UTC (permalink / raw)
  To: linux-kernel
  Cc: Randy Dunlap, Jonathan Corbet, Shuah Khan, Wim Van Sebroeck,
	Guenter Roeck, linux-watchdog, linux-doc

Correct some grammar and spelling mistakes in mlx-wdt.rst.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Shuah Khan <skhan@linuxfoundation.org>
Cc: Wim Van Sebroeck <wim@linux-watchdog.org>
Cc: Guenter Roeck <linux@roeck-us.net>
Cc: linux-watchdog@vger.kernel.org
Cc: linux-doc@vger.kernel.org

 Documentation/watchdog/mlx-wdt.rst |    4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

--- linux-next-20260226.orig/Documentation/watchdog/mlx-wdt.rst
+++ linux-next-20260226/Documentation/watchdog/mlx-wdt.rst
@@ -28,7 +28,7 @@ Type 3:
   Same as Type 2 with extended maximum timeout period.
   Maximum timeout is 65535 sec.
 
-Type 1 HW watchdog implementation exist in old systems and
+Type 1 HW watchdog implementation exists in old systems and
 all new systems have type 2 HW watchdog.
 Two types of HW implementation have also different register map.
 
@@ -48,7 +48,7 @@ which is optional.
 Watchdog can be started during a probe, in this case it will be
 pinged by watchdog core before watchdog device will be opened by
 user space application.
-Watchdog can be initialised in nowayout way, i.e. oncse started
+Watchdog can be initialised in nowayout mode, i.e. once started
 it can't be stopped.
 
 This mlx-wdt driver supports both HW watchdog implementations.

^ permalink raw reply	[flat|nested] 13+ messages in thread

* [PATCH 2/5] docs: watchdog: pcwd: fix typo and driver info.
  2026-02-28  1:03 [PATCH 0/5] docs: watchdog: general cleaning and corrections Randy Dunlap
  2026-02-28  1:03 ` [PATCH 1/5] docs: watchdog: mlx-wdt: small fixes Randy Dunlap
@ 2026-02-28  1:03 ` Randy Dunlap
  2026-02-28  1:51   ` Guenter Roeck
  2026-02-28  1:04 ` [PATCH 3/5] docs: watchdog-api: general cleaning Randy Dunlap
                   ` (3 subsequent siblings)
  5 siblings, 1 reply; 13+ messages in thread
From: Randy Dunlap @ 2026-02-28  1:03 UTC (permalink / raw)
  To: linux-kernel
  Cc: Randy Dunlap, Jonathan Corbet, Shuah Khan, Wim Van Sebroeck,
	Guenter Roeck, linux-watchdog, linux-doc

Correct a typo and some technical info for the pcwd driver.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Shuah Khan <skhan@linuxfoundation.org>
Cc: Wim Van Sebroeck <wim@linux-watchdog.org>
Cc: Guenter Roeck <linux@roeck-us.net>
Cc: linux-watchdog@vger.kernel.org
Cc: linux-doc@vger.kernel.org

 Documentation/watchdog/pcwd-watchdog.rst |   19 +++++++++++++------
 1 file changed, 13 insertions(+), 6 deletions(-)

--- linux-next-20260226.orig/Documentation/watchdog/pcwd-watchdog.rst
+++ linux-next-20260226/Documentation/watchdog/pcwd-watchdog.rst
@@ -29,7 +29,7 @@ Documentation and Driver by Ken Hollis <
  to run the program with an "&" to run it in the background!)
 
  If you want to write a program to be compatible with the PC Watchdog
- driver, simply use of modify the watchdog test program:
+ driver, simply use or modify the watchdog test program:
  tools/testing/selftests/watchdog/watchdog-test.c
 
 
@@ -37,16 +37,23 @@ Documentation and Driver by Ken Hollis <
 
 	WDIOC_GETSUPPORT
 		This returns the support of the card itself.  This
-		returns in structure "PCWDS" which returns:
+		returns in structure watchdog_info:
+
+                        identity = "PCWD"
+
+			options = list of supported options::
+                                  WDIOF_OVERHEAT
+                                  WDIOF_CARDRESET
+                                  WDIOF_KEEPALIVEPING
+                                  WDIOF_SETTIMEOUT
+                                  WDIOF_MAGICCLOSE
 
-			options = WDIOS_TEMPPANIC
-				  (This card supports temperature)
 			firmware_version = xxxx
 				  (Firmware version of the card)
 
 	WDIOC_GETSTATUS
 		This returns the status of the card, with the bits of
-		WDIOF_* bitwise-anded into the value.  (The comments
+		WDIOF_* bitwise-ored into the value.  (The comments
 		are in include/uapi/linux/watchdog.h)
 
 	WDIOC_GETBOOTSTATUS
@@ -55,7 +62,7 @@ Documentation and Driver by Ken Hollis <
 
 	WDIOC_GETTEMP
 		This returns the temperature of the card.  (You can also
-		read /dev/watchdog, which gives a temperature update
+		read /dev/temperature, which gives a temperature update
 		every second.)
 
 	WDIOC_SETOPTIONS

^ permalink raw reply	[flat|nested] 13+ messages in thread

* [PATCH 3/5] docs: watchdog-api: general cleaning
  2026-02-28  1:03 [PATCH 0/5] docs: watchdog: general cleaning and corrections Randy Dunlap
  2026-02-28  1:03 ` [PATCH 1/5] docs: watchdog: mlx-wdt: small fixes Randy Dunlap
  2026-02-28  1:03 ` [PATCH 2/5] docs: watchdog: pcwd: fix typo and driver info Randy Dunlap
@ 2026-02-28  1:04 ` Randy Dunlap
  2026-02-28  1:53   ` Guenter Roeck
  2026-02-28  1:04 ` [PATCH 4/5] docs: watchdog-kernel-api: general cleanups Randy Dunlap
                   ` (2 subsequent siblings)
  5 siblings, 1 reply; 13+ messages in thread
From: Randy Dunlap @ 2026-02-28  1:04 UTC (permalink / raw)
  To: linux-kernel
  Cc: Randy Dunlap, Jonathan Corbet, Shuah Khan, Wim Van Sebroeck,
	Guenter Roeck, linux-watchdog, linux-doc

Correct some grammar, punctuation, and capitalization mistakes.

Drop extra words in printf() calls [likely a copy-paste error].

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Shuah Khan <skhan@linuxfoundation.org>
Cc: Wim Van Sebroeck <wim@linux-watchdog.org>
Cc: Guenter Roeck <linux@roeck-us.net>
Cc: linux-watchdog@vger.kernel.org
Cc: linux-doc@vger.kernel.org

 Documentation/watchdog/watchdog-api.rst |   38 +++++++++++-----------
 1 file changed, 20 insertions(+), 18 deletions(-)

--- linux-next-20260226.orig/Documentation/watchdog/watchdog-api.rst
+++ linux-next-20260226/Documentation/watchdog/watchdog-api.rst
@@ -39,12 +39,12 @@ The simplest API
 
 All drivers support the basic mode of operation, where the watchdog
 activates as soon as /dev/watchdog is opened and will reboot unless
-the watchdog is pinged within a certain time, this time is called the
+the watchdog is pinged within a certain time; this time is called the
 timeout or margin.  The simplest way to ping the watchdog is to write
 some data to the device.  So a very simple watchdog daemon would look
 like this source file:  see samples/watchdog/watchdog-simple.c
 
-A more advanced driver could for example check that a HTTP server is
+A more advanced driver could for example check that an HTTP server is
 still responding before doing the write call to ping the watchdog.
 
 When the device is closed, the watchdog is disabled, unless the "Magic
@@ -87,13 +87,13 @@ replaced with::
 		sleep(10);
 	}
 
-the argument to the ioctl is ignored.
+The argument to the ioctl is ignored.
 
 Setting and getting the timeout
 ===============================
 
 For some drivers it is possible to modify the watchdog timeout on the
-fly with the SETTIMEOUT ioctl, those drivers have the WDIOF_SETTIMEOUT
+fly with the SETTIMEOUT ioctl; those drivers have the WDIOF_SETTIMEOUT
 flag set in their option field.  The argument is an integer
 representing the timeout in seconds.  The driver returns the real
 timeout used in the same variable, and this timeout might differ from
@@ -110,7 +110,7 @@ Starting with the Linux 2.4.18 kernel, i
 current timeout using the GETTIMEOUT ioctl::
 
     ioctl(fd, WDIOC_GETTIMEOUT, &timeout);
-    printf("The timeout was is %d seconds\n", timeout);
+    printf("The timeout is %d seconds\n", timeout);
 
 Pretimeouts
 ===========
@@ -133,7 +133,7 @@ seconds.  Setting a pretimeout to zero d
 There is also a get function for getting the pretimeout::
 
     ioctl(fd, WDIOC_GETPRETIMEOUT, &timeout);
-    printf("The pretimeout was is %d seconds\n", timeout);
+    printf("The pretimeout is %d seconds\n", timeout);
 
 Not all watchdog drivers will support a pretimeout.
 
@@ -145,13 +145,13 @@ before the system will reboot. The WDIOC
 that returns the number of seconds before reboot::
 
     ioctl(fd, WDIOC_GETTIMELEFT, &timeleft);
-    printf("The timeout was is %d seconds\n", timeleft);
+    printf("The timeout is %d seconds\n", timeleft);
 
 Environmental monitoring
 ========================
 
-All watchdog drivers are required return more information about the system,
-some do temperature, fan and power level monitoring, some can tell you
+All watchdog drivers are required to return more information about the system.
+Some do temperature, fan and power level monitoring; some can tell you
 the reason for the last reboot of the system.  The GETSUPPORT ioctl is
 available to ask what the device can do::
 
@@ -166,7 +166,7 @@ the fields returned in the ident struct
 	options			a flags describing what the device supports
 	================	=============================================
 
-the options field can have the following bits set, and describes what
+The options field can have the following bits set, and describes what
 kind of information that the GET_STATUS and GET_BOOT_STATUS ioctls can
 return.
 
@@ -175,13 +175,13 @@ return.
 	================	=========================
 
 The machine was last rebooted by the watchdog because the thermal limit was
-exceeded:
+exceeded.
 
 	==============		==========
 	WDIOF_FANFAULT		Fan failed
 	==============		==========
 
-A system fan monitored by the watchdog card has failed
+A system fan monitored by the watchdog card has failed.
 
 	=============		================
 	WDIOF_EXTERN1		External relay 1
@@ -195,26 +195,26 @@ a reset.
 	WDIOF_EXTERN2		External relay 2
 	=============		================
 
-External monitoring relay/source 2 was triggered
+External monitoring relay/source 2 was triggered.
 
 	================	=====================
 	WDIOF_POWERUNDER	Power bad/power fault
 	================	=====================
 
-The machine is showing an undervoltage status
+The machine is showing an undervoltage status.
 
 	===============		=============================
 	WDIOF_CARDRESET		Card previously reset the CPU
 	===============		=============================
 
-The last reboot was caused by the watchdog card
+The last reboot was caused by the watchdog card.
 
 	================	=====================
 	WDIOF_POWEROVER		Power over voltage
 	================	=====================
 
 The machine is showing an overvoltage status. Note that if one level is
-under and one over both bits will be set - this may seem odd but makes
+under and one over, both bits will be set - this may seem odd but makes
 sense.
 
 	===================	=====================
@@ -227,12 +227,14 @@ The watchdog saw a keepalive ping since
 	WDIOF_SETTIMEOUT	Can set/get the timeout
 	================	=======================
 
-The watchdog can do pretimeouts.
+The watchdog can get/set the timeout.
 
 	================	================================
 	WDIOF_PRETIMEOUT	Pretimeout (in seconds), get/set
 	================	================================
 
+The watchdog can do pretimeouts.
+
 
 For those drivers that return any bits set in the option field, the
 GETSTATUS and GETBOOTSTATUS ioctls can be used to ask for the current
@@ -255,7 +257,7 @@ returned value is the temperature in deg
     ioctl(fd, WDIOC_GETTEMP, &temperature);
 
 Finally the SETOPTIONS ioctl can be used to control some aspects of
-the cards operation::
+the card's operation::
 
     int options = 0;
     ioctl(fd, WDIOC_SETOPTIONS, &options);

^ permalink raw reply	[flat|nested] 13+ messages in thread

* [PATCH 4/5] docs: watchdog-kernel-api: general cleanups
  2026-02-28  1:03 [PATCH 0/5] docs: watchdog: general cleaning and corrections Randy Dunlap
                   ` (2 preceding siblings ...)
  2026-02-28  1:04 ` [PATCH 3/5] docs: watchdog-api: general cleaning Randy Dunlap
@ 2026-02-28  1:04 ` Randy Dunlap
  2026-02-28  1:55   ` Guenter Roeck
  2026-02-28  1:04 ` [PATCH 5/5] docs: watchdog-parameters: add missing watchdog_core parameters Randy Dunlap
  2026-03-03 17:23 ` [PATCH 0/5] docs: watchdog: general cleaning and corrections Jonathan Corbet
  5 siblings, 1 reply; 13+ messages in thread
From: Randy Dunlap @ 2026-02-28  1:04 UTC (permalink / raw)
  To: linux-kernel
  Cc: Randy Dunlap, Jonathan Corbet, Shuah Khan, Wim Van Sebroeck,
	Guenter Roeck, linux-watchdog, linux-doc

Fix grammar and punctuation.
Add a missing struct member (pm_nb) and its description.
Add a subheading for Helper Functions between the struct descriptions
and just pure helper functions.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Shuah Khan <skhan@linuxfoundation.org>
Cc: Wim Van Sebroeck <wim@linux-watchdog.org>
Cc: Guenter Roeck <linux@roeck-us.net>
Cc: linux-watchdog@vger.kernel.org
Cc: linux-doc@vger.kernel.org

 Documentation/watchdog/watchdog-kernel-api.rst |   20 +++++++++------
 1 file changed, 13 insertions(+), 7 deletions(-)

--- linux-next-20260226.orig/Documentation/watchdog/watchdog-kernel-api.rst
+++ linux-next-20260226/Documentation/watchdog/watchdog-kernel-api.rst
@@ -38,8 +38,8 @@ The watchdog_unregister_device routine d
 device. The parameter of this routine is the pointer to the registered
 watchdog_device structure.
 
-The watchdog subsystem includes an registration deferral mechanism,
-which allows you to register an watchdog as early as you wish during
+The watchdog subsystem includes a registration deferral mechanism,
+which allows you to register a watchdog as early as you wish during
 the boot process.
 
 The watchdog device structure looks like this::
@@ -60,13 +60,14 @@ The watchdog device structure looks like
 	unsigned int max_hw_heartbeat_ms;
 	struct notifier_block reboot_nb;
 	struct notifier_block restart_nb;
+	struct notifier_block pm_nb;
 	void *driver_data;
 	struct watchdog_core_data *wd_data;
 	unsigned long status;
 	struct list_head deferred;
   };
 
-It contains following fields:
+It contains the following fields:
 
 * id: set by watchdog_register_device, id 0 is special. It has both a
   /dev/watchdog0 cdev (dynamic major, minor 0) as well as the old
@@ -105,6 +106,8 @@ It contains following fields:
   internal use only. If a watchdog is capable of restarting the machine, it
   should define ops->restart. Priority can be changed through
   watchdog_set_restart_priority.
+* pm_nb: coordinates watchdog_dev_suspend/resume to cancel a ping worker
+  during suspend and restore it during resume.
 * bootstatus: status of the device after booting (reported with watchdog
   WDIOF_* status bits).
 * driver_data: a pointer to the drivers private data of a watchdog device.
@@ -204,7 +207,7 @@ they are supported. These optional routi
   If the watchdog driver does not have to perform any action but setting the
   watchdog_device.timeout, this callback can be omitted.
 
-  If set_timeout is not provided but, WDIOF_SETTIMEOUT is set, the watchdog
+  If set_timeout is not provided but WDIOF_SETTIMEOUT is set, the watchdog
   infrastructure updates the timeout value of the watchdog_device internally
   to the requested value.
 
@@ -220,7 +223,7 @@ they are supported. These optional routi
   the watchdog". A value of 0 disables pretimeout notification.
 
   (Note: the WDIOF_PRETIMEOUT needs to be set in the options field of the
-  watchdog's info structure).
+  watchdog's info structure.)
 
   If the watchdog driver does not have to perform any action but setting the
   watchdog_device.pretimeout, this callback can be omitted. That means if
@@ -239,7 +242,7 @@ they are supported. These optional routi
 The status bits should (preferably) be set with the set_bit and clear_bit alike
 bit-operations. The status bits that are defined are:
 
-* WDOG_ACTIVE: this status bit indicates whether or not a watchdog timer device
+* WDOG_ACTIVE: this status bit indicates whether a watchdog timer device
   is active or not from user perspective. User space is expected to send
   heartbeat requests to the driver while this flag is set.
 * WDOG_NO_WAY_OUT: this bit stores the nowayout setting for the watchdog.
@@ -254,6 +257,9 @@ bit-operations. The status bits that are
   then opening /dev/watchdog will skip the start operation but send a keepalive
   request instead.
 
+Helper Functions
+~~~~~~~~~~~~~~~~
+
   To set the WDOG_NO_WAY_OUT status bit (before registering your watchdog
   timer device) you can either:
 
@@ -331,7 +337,7 @@ To raise a pretimeout notification, the
   void watchdog_notify_pretimeout(struct watchdog_device *wdd)
 
 The function can be called in the interrupt context. If watchdog pretimeout
-governor framework (kbuild CONFIG_WATCHDOG_PRETIMEOUT_GOV symbol) is enabled,
+governor framework (kconfig CONFIG_WATCHDOG_PRETIMEOUT_GOV symbol) is enabled,
 an action is taken by a preconfigured pretimeout governor preassigned to
 the watchdog device. If watchdog pretimeout governor framework is not
 enabled, watchdog_notify_pretimeout() prints a notification message to

^ permalink raw reply	[flat|nested] 13+ messages in thread

* [PATCH 5/5] docs: watchdog-parameters: add missing watchdog_core parameters
  2026-02-28  1:03 [PATCH 0/5] docs: watchdog: general cleaning and corrections Randy Dunlap
                   ` (3 preceding siblings ...)
  2026-02-28  1:04 ` [PATCH 4/5] docs: watchdog-kernel-api: general cleanups Randy Dunlap
@ 2026-02-28  1:04 ` Randy Dunlap
  2026-02-28  1:54   ` Guenter Roeck
  2026-03-03 17:23 ` [PATCH 0/5] docs: watchdog: general cleaning and corrections Jonathan Corbet
  5 siblings, 1 reply; 13+ messages in thread
From: Randy Dunlap @ 2026-02-28  1:04 UTC (permalink / raw)
  To: linux-kernel
  Cc: Randy Dunlap, Jonathan Corbet, Shuah Khan, Wim Van Sebroeck,
	Guenter Roeck, linux-watchdog, linux-doc

Add missing watchdog_core parameters (handle_boot_enabled and
stop_on_reboot).
Add default values for handle_boot_enabled and open_timeout.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Shuah Khan <skhan@linuxfoundation.org>
Cc: Wim Van Sebroeck <wim@linux-watchdog.org>
Cc: Guenter Roeck <linux@roeck-us.net>
Cc: linux-watchdog@vger.kernel.org
Cc: linux-doc@vger.kernel.org

 Documentation/watchdog/watchdog-parameters.rst |   11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

--- linux-next-20260227.orig/Documentation/watchdog/watchdog-parameters.rst
+++ linux-next-20260227/Documentation/watchdog/watchdog-parameters.rst
@@ -14,13 +14,22 @@ modules.
 -------------------------------------------------
 
 watchdog core:
+    handle_boot_enabled:
+	Watchdog core auto-updates boot-enabled watchdogs before userspace
+	takes over. Default is set by the kconfig option
+	CONFIG_WATCHDOG_HANDLE_BOOT_ENABLED.
+
     open_timeout:
 	Maximum time, in seconds, for which the watchdog framework will take
 	care of pinging a running hardware watchdog until userspace opens the
 	corresponding /dev/watchdogN device. A value of 0 means an infinite
 	timeout. Setting this to a non-zero value can be useful to ensure that
 	either userspace comes up properly, or the board gets reset and allows
-	fallback logic in the bootloader to try something else.
+	fallback logic in the bootloader to try something else. Default is set
+	by the kconfig option CONFIG_WATCHDOG_OPEN_TIMEOUT.
+
+    stop_on_reboot:
+	Stops watchdogs on reboot (0 = keep watching, 1 = stop).
 
 -------------------------------------------------
 

^ permalink raw reply	[flat|nested] 13+ messages in thread

* Re: [PATCH 1/5] docs: watchdog: mlx-wdt: small fixes
  2026-02-28  1:03 ` [PATCH 1/5] docs: watchdog: mlx-wdt: small fixes Randy Dunlap
@ 2026-02-28  1:51   ` Guenter Roeck
  0 siblings, 0 replies; 13+ messages in thread
From: Guenter Roeck @ 2026-02-28  1:51 UTC (permalink / raw)
  To: Randy Dunlap
  Cc: linux-kernel, Jonathan Corbet, Shuah Khan, Wim Van Sebroeck,
	linux-watchdog, linux-doc

On Fri, Feb 27, 2026 at 05:03:58PM -0800, Randy Dunlap wrote:
> Correct some grammar and spelling mistakes in mlx-wdt.rst.
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> ---

Reviewed-by: Guenter Roeck <linux@roeck-us.net>

> Cc: Jonathan Corbet <corbet@lwn.net>
> Cc: Shuah Khan <skhan@linuxfoundation.org>
> Cc: Wim Van Sebroeck <wim@linux-watchdog.org>
> Cc: Guenter Roeck <linux@roeck-us.net>
> Cc: linux-watchdog@vger.kernel.org
> Cc: linux-doc@vger.kernel.org
> 
>  Documentation/watchdog/mlx-wdt.rst |    4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> --- linux-next-20260226.orig/Documentation/watchdog/mlx-wdt.rst
> +++ linux-next-20260226/Documentation/watchdog/mlx-wdt.rst
> @@ -28,7 +28,7 @@ Type 3:
>    Same as Type 2 with extended maximum timeout period.
>    Maximum timeout is 65535 sec.
>  
> -Type 1 HW watchdog implementation exist in old systems and
> +Type 1 HW watchdog implementation exists in old systems and
>  all new systems have type 2 HW watchdog.
>  Two types of HW implementation have also different register map.
>  
> @@ -48,7 +48,7 @@ which is optional.
>  Watchdog can be started during a probe, in this case it will be
>  pinged by watchdog core before watchdog device will be opened by
>  user space application.
> -Watchdog can be initialised in nowayout way, i.e. oncse started
> +Watchdog can be initialised in nowayout mode, i.e. once started
>  it can't be stopped.
>  
>  This mlx-wdt driver supports both HW watchdog implementations.

^ permalink raw reply	[flat|nested] 13+ messages in thread

* Re: [PATCH 2/5] docs: watchdog: pcwd: fix typo and driver info.
  2026-02-28  1:03 ` [PATCH 2/5] docs: watchdog: pcwd: fix typo and driver info Randy Dunlap
@ 2026-02-28  1:51   ` Guenter Roeck
  0 siblings, 0 replies; 13+ messages in thread
From: Guenter Roeck @ 2026-02-28  1:51 UTC (permalink / raw)
  To: Randy Dunlap
  Cc: linux-kernel, Jonathan Corbet, Shuah Khan, Wim Van Sebroeck,
	linux-watchdog, linux-doc

On Fri, Feb 27, 2026 at 05:03:59PM -0800, Randy Dunlap wrote:
> Correct a typo and some technical info for the pcwd driver.
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> ---

Reviewed-by: Guenter Roeck <linux@roeck-us.net>

^ permalink raw reply	[flat|nested] 13+ messages in thread

* Re: [PATCH 3/5] docs: watchdog-api: general cleaning
  2026-02-28  1:04 ` [PATCH 3/5] docs: watchdog-api: general cleaning Randy Dunlap
@ 2026-02-28  1:53   ` Guenter Roeck
  0 siblings, 0 replies; 13+ messages in thread
From: Guenter Roeck @ 2026-02-28  1:53 UTC (permalink / raw)
  To: Randy Dunlap
  Cc: linux-kernel, Jonathan Corbet, Shuah Khan, Wim Van Sebroeck,
	linux-watchdog, linux-doc

On Fri, Feb 27, 2026 at 05:04:00PM -0800, Randy Dunlap wrote:
> Correct some grammar, punctuation, and capitalization mistakes.
> 
> Drop extra words in printf() calls [likely a copy-paste error].
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>

Reviewed-by: Guenter Roeck <linux@roeck-us.net>

^ permalink raw reply	[flat|nested] 13+ messages in thread

* Re: [PATCH 5/5] docs: watchdog-parameters: add missing watchdog_core parameters
  2026-02-28  1:04 ` [PATCH 5/5] docs: watchdog-parameters: add missing watchdog_core parameters Randy Dunlap
@ 2026-02-28  1:54   ` Guenter Roeck
  0 siblings, 0 replies; 13+ messages in thread
From: Guenter Roeck @ 2026-02-28  1:54 UTC (permalink / raw)
  To: Randy Dunlap
  Cc: linux-kernel, Jonathan Corbet, Shuah Khan, Wim Van Sebroeck,
	linux-watchdog, linux-doc

On Fri, Feb 27, 2026 at 05:04:02PM -0800, Randy Dunlap wrote:
> Add missing watchdog_core parameters (handle_boot_enabled and
> stop_on_reboot).
> Add default values for handle_boot_enabled and open_timeout.
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>

Reviewed-by: Guenter Roeck <linux@roeck-us.net>

> ---
> Cc: Jonathan Corbet <corbet@lwn.net>
> Cc: Shuah Khan <skhan@linuxfoundation.org>
> Cc: Wim Van Sebroeck <wim@linux-watchdog.org>
> Cc: Guenter Roeck <linux@roeck-us.net>
> Cc: linux-watchdog@vger.kernel.org
> Cc: linux-doc@vger.kernel.org
> 
>  Documentation/watchdog/watchdog-parameters.rst |   11 ++++++++++-
>  1 file changed, 10 insertions(+), 1 deletion(-)
> 
> --- linux-next-20260227.orig/Documentation/watchdog/watchdog-parameters.rst
> +++ linux-next-20260227/Documentation/watchdog/watchdog-parameters.rst
> @@ -14,13 +14,22 @@ modules.
>  -------------------------------------------------
>  
>  watchdog core:
> +    handle_boot_enabled:
> +	Watchdog core auto-updates boot-enabled watchdogs before userspace
> +	takes over. Default is set by the kconfig option
> +	CONFIG_WATCHDOG_HANDLE_BOOT_ENABLED.
> +
>      open_timeout:
>  	Maximum time, in seconds, for which the watchdog framework will take
>  	care of pinging a running hardware watchdog until userspace opens the
>  	corresponding /dev/watchdogN device. A value of 0 means an infinite
>  	timeout. Setting this to a non-zero value can be useful to ensure that
>  	either userspace comes up properly, or the board gets reset and allows
> -	fallback logic in the bootloader to try something else.
> +	fallback logic in the bootloader to try something else. Default is set
> +	by the kconfig option CONFIG_WATCHDOG_OPEN_TIMEOUT.
> +
> +    stop_on_reboot:
> +	Stops watchdogs on reboot (0 = keep watching, 1 = stop).
>  
>  -------------------------------------------------
>  

^ permalink raw reply	[flat|nested] 13+ messages in thread

* Re: [PATCH 4/5] docs: watchdog-kernel-api: general cleanups
  2026-02-28  1:04 ` [PATCH 4/5] docs: watchdog-kernel-api: general cleanups Randy Dunlap
@ 2026-02-28  1:55   ` Guenter Roeck
  0 siblings, 0 replies; 13+ messages in thread
From: Guenter Roeck @ 2026-02-28  1:55 UTC (permalink / raw)
  To: Randy Dunlap, linux-kernel
  Cc: Jonathan Corbet, Shuah Khan, Wim Van Sebroeck, linux-watchdog,
	linux-doc

On 2/27/26 17:04, Randy Dunlap wrote:
> Fix grammar and punctuation.
> Add a missing struct member (pm_nb) and its description.
> Add a subheading for Helper Functions between the struct descriptions
> and just pure helper functions.
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>

Reviewed-by: Guenter Roeck <linux@roeck-us.net>


^ permalink raw reply	[flat|nested] 13+ messages in thread

* Re: [PATCH 0/5] docs: watchdog: general cleaning and corrections
  2026-02-28  1:03 [PATCH 0/5] docs: watchdog: general cleaning and corrections Randy Dunlap
                   ` (4 preceding siblings ...)
  2026-02-28  1:04 ` [PATCH 5/5] docs: watchdog-parameters: add missing watchdog_core parameters Randy Dunlap
@ 2026-03-03 17:23 ` Jonathan Corbet
  2026-03-23  0:54   ` Randy Dunlap
  5 siblings, 1 reply; 13+ messages in thread
From: Jonathan Corbet @ 2026-03-03 17:23 UTC (permalink / raw)
  To: Randy Dunlap, linux-kernel
  Cc: Randy Dunlap, Shuah Khan, Wim Van Sebroeck, Guenter Roeck,
	linux-watchdog, linux-doc

Randy Dunlap <rdunlap@infradead.org> writes:

> Fix some obvious issues in the watchdog documentation files.
> I didn't try to fix every little niggling mistake.
>
>  [PATCH 1/5] docs: watchdog: mlx-wdt: small fixes
>  [PATCH 2/5] docs: watchdog: pcwd: fix typo and driver info.
>  [PATCH 3/5] docs: watchdog-api: general cleaning
>  [PATCH 4/5] docs: watchdog-kernel-api: general cleanups
>  [PATCH 5/5] docs: watchdog-parameters: add missing watchdog_core parameters
>
>  Documentation/watchdog/mlx-wdt.rst             |    4 -
>  Documentation/watchdog/pcwd-watchdog.rst       |   19 +++++--
>  Documentation/watchdog/watchdog-api.rst        |   38 +++++++--------
>  Documentation/watchdog/watchdog-kernel-api.rst |   20 +++++--
>  Documentation/watchdog/watchdog-parameters.rst |   11 +++-
>  5 files changed, 58 insertions(+), 34 deletions(-)

Wim, do you want to pick these up, or should I take them through the
docs tree?

Thanks,

jon

^ permalink raw reply	[flat|nested] 13+ messages in thread

* Re: [PATCH 0/5] docs: watchdog: general cleaning and corrections
  2026-03-03 17:23 ` [PATCH 0/5] docs: watchdog: general cleaning and corrections Jonathan Corbet
@ 2026-03-23  0:54   ` Randy Dunlap
  0 siblings, 0 replies; 13+ messages in thread
From: Randy Dunlap @ 2026-03-23  0:54 UTC (permalink / raw)
  To: Jonathan Corbet, linux-kernel
  Cc: Shuah Khan, Wim Van Sebroeck, Guenter Roeck, linux-watchdog,
	linux-doc



On 3/3/26 9:23 AM, Jonathan Corbet wrote:
> Randy Dunlap <rdunlap@infradead.org> writes:
> 
>> Fix some obvious issues in the watchdog documentation files.
>> I didn't try to fix every little niggling mistake.
>>
>>  [PATCH 1/5] docs: watchdog: mlx-wdt: small fixes
>>  [PATCH 2/5] docs: watchdog: pcwd: fix typo and driver info.
>>  [PATCH 3/5] docs: watchdog-api: general cleaning
>>  [PATCH 4/5] docs: watchdog-kernel-api: general cleanups
>>  [PATCH 5/5] docs: watchdog-parameters: add missing watchdog_core parameters
>>
>>  Documentation/watchdog/mlx-wdt.rst             |    4 -
>>  Documentation/watchdog/pcwd-watchdog.rst       |   19 +++++--
>>  Documentation/watchdog/watchdog-api.rst        |   38 +++++++--------
>>  Documentation/watchdog/watchdog-kernel-api.rst |   20 +++++--
>>  Documentation/watchdog/watchdog-parameters.rst |   11 +++-
>>  5 files changed, 58 insertions(+), 34 deletions(-)
> 
> Wim, do you want to pick these up, or should I take them through the
> docs tree?

Wim, are you active?  Can you reply and/or merge these?

thanks.
-- 
~Randy


^ permalink raw reply	[flat|nested] 13+ messages in thread

end of thread, other threads:[~2026-03-23  0:54 UTC | newest]

Thread overview: 13+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2026-02-28  1:03 [PATCH 0/5] docs: watchdog: general cleaning and corrections Randy Dunlap
2026-02-28  1:03 ` [PATCH 1/5] docs: watchdog: mlx-wdt: small fixes Randy Dunlap
2026-02-28  1:51   ` Guenter Roeck
2026-02-28  1:03 ` [PATCH 2/5] docs: watchdog: pcwd: fix typo and driver info Randy Dunlap
2026-02-28  1:51   ` Guenter Roeck
2026-02-28  1:04 ` [PATCH 3/5] docs: watchdog-api: general cleaning Randy Dunlap
2026-02-28  1:53   ` Guenter Roeck
2026-02-28  1:04 ` [PATCH 4/5] docs: watchdog-kernel-api: general cleanups Randy Dunlap
2026-02-28  1:55   ` Guenter Roeck
2026-02-28  1:04 ` [PATCH 5/5] docs: watchdog-parameters: add missing watchdog_core parameters Randy Dunlap
2026-02-28  1:54   ` Guenter Roeck
2026-03-03 17:23 ` [PATCH 0/5] docs: watchdog: general cleaning and corrections Jonathan Corbet
2026-03-23  0:54   ` Randy Dunlap

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox