[libvirt] [PATCH 21/34] qemu: monitor: Explain logic of qemuMonitorGetCPUInfo

The return value has non-obvious semantics. Document it. --- src/qemu/qemu_monitor.c | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/src/qemu/qemu_monitor.c b/src/qemu/qemu_monitor.c index 50c6549..cf7ecb6 100644 --- 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) -- 2.6.2