include/qemu/thread.h: Document qemu_thread_atexit* API
commitca95173c7fb64a1544b1f560766976425659e5e4
authorPeter Maydell <peter.maydell@linaro.org>
Mon, 5 Nov 2018 13:55:37 +0000 (5 13:55 +0000)
committerPaolo Bonzini <pbonzini@redhat.com>
Tue, 6 Nov 2018 20:35:06 +0000 (6 21:35 +0100)
tree35f86de35c5c87b7f5c97b4a1f1143fd761ecc2b
parent763c56872b08b98fde062a1feca003f200e7bd5c
include/qemu/thread.h: Document qemu_thread_atexit* API

Add documentation for the qemu_thread_atexit_add() and
qemu_thread_atexit_remove() functions.

We include a (previously undocumented) constraint that notifiers
may not be called if a thread is exiting because the entire
process is exiting. This is fine for our current use because
the callers use it only for cleaning up resources which go away
on process exit (memory, Win32 fibers), and we will need the
flexibility for the new posix implementation.

Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Reviewed-by: Eric Blake <eblake@redhat.com>
Message-Id: <20181105135538.28025-2-peter.maydell@linaro.org>
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
include/qemu/thread.h