qemu: monitor: Explain logic of qemuMonitorGetCPUInfo

The return value has non-obvious semantics. Document it.

diff --git a/src/qemu/qemu_monitor.c b/src/qemu/qemu_monitor.c
index 50c6549377b5cefb5447f76b53f3a61619f785d9..cf7ecb6e398ac21fad567bc9226f180e963cc87f 100644 (file)
--- a/src/qemu/qemu_monitor.c
+++ b/src/qemu/qemu_monitor.c
@@ -1606,6 +1606,15 @@ qemuMonitorSystemReset(qemuMonitorPtr mon)
 }
 
 
+/**
+ * qemuMonitorGetCPUInfo:
+ * @mon: monitor
+ * @pids: returned array of thread ids corresponding to the vCPUs
+ *
+ * Detects the vCPU thread ids. Returns count of detected vCPUs on success,
+ * 0 if qemu didn't report thread ids (does not report libvirt error),
+ * -1 on error (reports libvirt error).
+ */
 int
 qemuMonitorGetCPUInfo(qemuMonitorPtr mon,
                       int **pids)