From 2756609a3eeee428a69d7278089d4fee39802488 Mon Sep 17 00:00:00 2001 From: Michal Privoznik Date: Mon, 5 May 2025 10:51:52 +0200 Subject: [PATCH] docs: hooks: Document when shutoff-reason argument was introduced 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 Reviewed-by: Peter Krempa --- docs/hooks.rst | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/hooks.rst b/docs/hooks.rst index 48128ba3d8..e1745b8cc7 100644 --- a/docs/hooks.rst +++ b/docs/hooks.rst @@ -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. :: -- 2.47.2