vm: document domain-start-failed event

2018-07-11 04:50:37 +02:00 · 2018-07-11 04:50:37 +02:00 · e51efcf980
commit e51efcf980
parent af2435c0d4
1 changed files with 11 additions and 0 deletions
--- a/qubes/vm/qubesvm.py
+++ b/qubes/vm/qubesvm.py
@ -176,6 +176,17 @@ class QubesVM(qubes.vm.mix.net.NetVMMixin, qubes.vm.BaseVM):

            *other arguments are as in :py:meth:`start`*

+        .. event:: domain-start-failed (subject, event, reason)
+
+            Fired when :py:meth:`start` method fails.
+            *reason* argument is a textual error message.
+
+            Handler for this event can be asynchronous (a coroutine).
+
+            :param subject: Event emitter (the qube object)
+            :param event: Event name (``'domain-start'``)
+
+            *other arguments are as in :py:meth:`start`*
        .. event:: domain-stopped (subject, event)

            Fired when domain has been stopped.