Mention cpu_pause() might not be immediately fullfilled: when the requested vCPU is not the current one, the request is asynchroneous.
Mention the method goes in pair with cpu_resume(). Signed-off-by: Philippe Mathieu-Daudé <[email protected]> --- include/hw/core/cpu.h | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/include/hw/core/cpu.h b/include/hw/core/cpu.h index 81af7b9ee1a..f1ac492714e 100644 --- a/include/hw/core/cpu.h +++ b/include/hw/core/cpu.h @@ -1045,10 +1045,13 @@ void cpu_reset_interrupt(CPUState *cpu, int mask); void cpu_exit(CPUState *cpu); /** - * cpu_pause: + * cpu_pause - Request the CPU to pause execution * @cpu: The CPU to pause. * - * Pauses CPU, i.e. puts CPU into stopped state. + * If @cpu is the current thread, immediately pause its execution; + * otherwise asynchronously request it to pause. + * + * Note: Use cpu_resume() to restart execution. */ void cpu_pause(CPUState *cpu); -- 2.53.0
