clap

commit 4fe03a6bda6bd3fa08096df2dcf8a2d208cd0d7a
parent 38bf20b05a3dc384ba3afb2bd83baa2ad64feacd
Author: Tim Janik <timj@gnu.org>
Date:   Thu,  7 Jul 2022 12:45:56 +0200

INCLUDE: clap/ext/thread-check.h: add @abique comment about threads moving

Signed-off-by: Tim Janik <timj@gnu.org>

Diffstat:
M
include/clap/ext/thread-check.h
 | 
5
+++--

1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/include/clap/ext/thread-check.h b/include/clap/ext/thread-check.h
@@ -18,8 +18,9 @@ extern "C" {
  * to meet realtime requirements. I.e. only carry out sufficiently performant and time-bound
  * operations. So mutexes, memory (de-)allocations, IO, UI rendering should generally be avoided.
  *
- * Depending on the host, [main-thread] and [audio-thread] may or may not map to the same
- * system thread. So while plugins should use the thread checking functions and may assert
+ * Depending on the host scheduler, the [audio-thread] may move from one OS thread to another,
+ * including the same OS thread as the [main-thread].
+ * So while plugins are encouraged to use the thread checking functions and may assert
  * is_main_thread() == true or is_audio_thread() == true in a particular context, it should
  * be avoided to assert that the current thread is *NOT* is_main_thread() or is_audio_thread().
  */