]> git.ipfire.org Git - thirdparty/libvirt.git/commitdiff
docs: hooks: Document when shutoff-reason argument was introduced
authorMichal Privoznik <mprivozn@redhat.com>
Mon, 5 May 2025 08:51:52 +0000 (10:51 +0200)
committerMichal Privoznik <mprivozn@redhat.com>
Tue, 6 May 2025 06:31:39 +0000 (08:31 +0200)
Introduced in v10.5.0-rc1~52, qemu and lxc hook scripts are
executed with additional argument: shutoff reason. But wording of
our docs make it looks like it's been that way forever. Make it
clear this is `recent` feature.

Resolves: https://gitlab.com/libvirt/libvirt/-/issues/766
Signed-off-by: Michal Privoznik <mprivozn@redhat.com>
Reviewed-by: Peter Krempa <pkrempa@redhat.com>
docs/hooks.rst

index 48128ba3d8c575e2ca2bcdafdc3bdfd4bfe43f62..e1745b8cc71d9ee9a41cbf2f4c81a9f5ce20afb3 100644 (file)
@@ -211,7 +211,10 @@ operation. There is no specific operation to indicate a "restart" is occurring.
       /etc/libvirt/hooks/qemu guest_name stopped end -
 
    Then, after libvirt has released all resources, the hook is called again,
-   :since:`since 0.9.0`, to allow any additional resource cleanup:
+   :since:`since 0.9.0`, to allow any additional resource cleanup.
+   The ``shutoff-reason`` argument (:since:`since 10.5.0`; before that
+   '-' was passed instead) provides the reason for the shutdown of
+   the domain.
 
    ::
 
@@ -331,7 +334,10 @@ operation. There is no specific operation to indicate a "restart" is occurring.
       /etc/libvirt/hooks/lxc guest_name stopped end -
 
    Then, after libvirt has released all resources, the hook is called again,
-   :since:`since 0.9.0`, to allow any additional resource cleanup:
+   :since:`since 0.9.0`, to allow any additional resource cleanup.
+   The ``shutoff-reason`` argument (:since:`since 10.5.0`; before that
+   '-' was passed instead) provides the reason for the shutdown of
+   the domain.
 
    ::