summaryrefslogtreecommitdiff
path: root/include/term
diff options
context:
space:
mode:
Diffstat (limited to 'include/term')
-rw-r--r--include/term/term.h12
1 files changed, 7 insertions, 5 deletions
diff --git a/include/term/term.h b/include/term/term.h
index dc41114..b9f3843 100644
--- a/include/term/term.h
+++ b/include/term/term.h
@@ -17,8 +17,9 @@
*
* Threads. Any thread can call any function. Each call that reads or changes
* a terminal enters its writer section, so calls on one terminal run one at a
- * time. A snapshot belongs to one thread at a time. term_free() is the last
- * call on a terminal.
+ * time. A thread that waits for the section sleeps. On POSIX the section is a
+ * mutex with priority inheritance where the platform has it. A snapshot
+ * belongs to one thread at a time. term_free() is the last call on a terminal.
*/
#include <stdbool.h>
@@ -169,9 +170,10 @@ TERM_API struct term *term_new(const struct term_options *opt);
TERM_API void term_free(struct term *t);
/* Hold the writer section across several calls, so that no other thread
- * changes the terminal between them. The section is a spin lock: keep it
- * short. The thread that holds it can call every function, and it can enter
- * the section again. */
+ * changes the terminal between them. The section is a mutex, and a waiting
+ * thread sleeps. Keep it short. The thread that holds it can call every
+ * function, and it can enter the section again. Each term_lock() needs one
+ * term_unlock(). */
TERM_API void term_lock(struct term *t);
TERM_API void term_unlock(struct term *t);