Quellcode durchsuchen

vm: document domain-start-failed event

Marek Marczykowski-Górecki vor 5 Jahren
Ursprung
Commit
e51efcf980
1 geänderte Dateien mit 11 neuen und 0 gelöschten Zeilen
  1. 11 0
      qubes/vm/qubesvm.py

+ 11 - 0
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.