qemu: monitor: Explain logic of qemuMonitorGetCPUInfo

The return value has non-obvious semantics. Document it.
This commit is contained in:
Peter Krempa 2015-10-29 14:30:23 +01:00
parent 3d0c59e5bb
commit 0076d8db97

View File

@ -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)