From: Michal Privoznik <mprivozn@redhat.com>
Date: Wed, 24 Feb 2021 12:55:33 +0000 (+0100)
Subject: qemu_monitor: Document qemuMonitorUnregister()
X-Git-Tag: v7.1.0-rc2^0
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=6458b9d94a1d5da62e46ac0b10f92aca103c27ab;p=thirdparty%2Flibvirt.git

qemu_monitor: Document qemuMonitorUnregister()

The most important bit is that the caller is expected to pass
locked monitor.

Signed-off-by: Michal Privoznik <mprivozn@redhat.com>
Reviewed-by: Andrea Bolognani <abologna@redhat.com>
---

diff --git a/src/qemu/qemu_monitor.c b/src/qemu/qemu_monitor.c
index ed35da17e1..73f337a6be 100644
--- a/src/qemu/qemu_monitor.c
+++ b/src/qemu/qemu_monitor.c
@@ -850,6 +850,13 @@ qemuMonitorRegister(qemuMonitorPtr mon)
 }
 
 
+/**
+ * qemuMonitorUnregister:
+ * @mon: monitor object
+ *
+ * Unregister monitor from the event loop. The monitor object
+ * must be locked before calling this function.
+ */
 void
 qemuMonitorUnregister(qemuMonitorPtr mon)
 {