qemuDomainObjPrivate: Annotate 'allowReboot' field

Save further readers the headache of determining what it actually does
and note that it's not used with qemu version supporting the
'set-action' command.

Signed-off-by: Peter Krempa <pkrempa@redhat.com>
Reviewed-by: Michal Privoznik <mprivozn@redhat.com>

diff --git a/src/qemu/qemu_domain.h b/src/qemu/qemu_domain.h
index abc3c7158d89fbb973d475dfee13cc26ae470436..f3c6bb33904395fc3702e04a5b7d1a4234404dcd 100644 (file)
--- a/src/qemu/qemu_domain.h
+++ b/src/qemu/qemu_domain.h
@@ -154,6 +154,14 @@ struct _qemuDomainObjPrivate {
 
     bool fakeReboot;
     bool pausedShutdown;
+    /* allowReboot:
+     *
+     * Unused with new QEMU versions which have QEMU_CAPS_SET_ACTION.
+     *
+     * Otherwise if it's set to VIR_TRISTATE_BOOL_YES, QEMU was started with
+     * -no-shutdown, and if set to VIR_TRISTATE_BOOL_NO qemu was started with
+     * -no-reboot instead.
+     */
     virTristateBool allowReboot;
 
     int jobs_queued;