[PATCH] 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> --- docs/formatdomain.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst index 4336cff3ac05..e6f09a728f0f 100644 --- 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` -- 2.46.2

On Fri, Oct 11, 2024 at 13:55:26 +0200, Martin Kletzander wrote:
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> --- docs/formatdomain.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst index 4336cff3ac05..e6f09a728f0f 100644 --- 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`
Reviewed-by: Jiri Denemark <jdenemar@redhat.com>

On Fri, Oct 11, 2024 at 01:55:26PM +0200, Martin Kletzander wrote:
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> --- docs/formatdomain.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst index 4336cff3ac05..e6f09a728f0f 100644 --- 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`
Acked-by: Richard W.M. Jones <rjones@redhat.com> -- Richard Jones, Virtualization Group, Red Hat http://people.redhat.com/~rjones Read my programming and virtualization blog: http://rwmj.wordpress.com Fedora Windows cross-compiler. Compile Windows programs, test, and build Windows installers. Over 100 libraries supported. http://fedoraproject.org/wiki/MinGW
participants (3)
-
Jiri Denemark
-
Martin Kletzander
-
Richard W.M. Jones