docs: Document watchdog action=dump slightly more

With watchdog action=dump the actual watchdog action is set to pause and
the daemon then proceeds to dump the process.  After that the domain is
resumed.  That was the case since the feature was added.  However the
resuming of the domain might be unexpected, especially when compared to
HW watchdog, which will never run the guest from the point where it got
interrupted.

Document the pre-existing behaviour, since any change might be
unexpected as well.  Change of behaviour would require new options like
dump+reset, dump+pause, etc.  That option is still possible, but
orthogonal to this change.

Resolves: https://issues.redhat.com/browse/RHEL-753
Signed-off-by: Martin Kletzander <mkletzan@redhat.com>
Reviewed-by: Jiri Denemark <jdenemar@redhat.com>

diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst
index 4336cff3ac05ca7c29839dfd8dc018e7b5ccfdf4..e6f09a728f0ffec0495563eb165d3d39659f780b 100644 (file)
--- a/docs/formatdomain.rst
+++ b/docs/formatdomain.rst
@@ -7914,7 +7914,8 @@ southbridge, which is used with the q35 machine type. :since:`Since 9.1.0`
    -  'poweroff' - forcefully power off the guest
    -  'pause' - pause the guest
    -  'none' - do nothing
-   -  'dump' - automatically dump the guest :since:`Since 0.8.7`
+   -  'dump' - automatically dump the guest, beware that after the
+      dump the guest will be resumed :since:`Since 0.8.7`
    -  'inject-nmi' - inject a non-maskable interrupt into the guest
       :since:`Since 1.2.17`