[PATCH 6/6] Documentation: user: watchdog: note new wd -x option

[Ahmad Fatoum <a.fatoum@pengutronix.de>]

wd command documentation is generated automatically and will list the
new -x option. It's still a good idea to reference this in the
watchdog user doc as well. Do so.

Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de>
---
 Documentation/user/watchdog.rst | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/Documentation/user/watchdog.rst b/Documentation/user/watchdog.rst
index ff400317a0bc..0220965598ed 100644
--- a/Documentation/user/watchdog.rst
+++ b/Documentation/user/watchdog.rst
@@ -10,6 +10,15 @@ the bootloader. For these scenarios barebox provides the watchdog framework
 with the following functionality and at least ``CONFIG_WATCHDOG`` should be
 enabled.
 
+Disabling for development
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The shorthand command ``wd -x`` will disable all watchdogs.
+If hardware (or driver) doesn't support turning off the watchdog,
+an autpoller will be registered to periodically feed watchdogs.
+This should only be needed for development.
+See :ref:`boot-watchdog-timeout` for how to use the watchdog in the field.
+
 Polling
 ~~~~~~~
 
@@ -98,6 +107,8 @@ device tree or via the ``priority`` device parameter. Normally, watchdogs
 that have a wider effect should be given the higher priority (e.g.
 PMIC watchdog resetting the board vs. SoC's watchdog resetting only itself).
 
+.. _boot-watchdog-timeout:
+
 Boot Watchdog Timeout
 ~~~~~~~~~~~~~~~~~~~~~
 
-- 
2.30.2


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox