luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-09-21 09:46:18 +02:00
Code Issues Packages Projects Releases Wiki Activity

locks: Add initialisation notes

Browse Source 
For each of the 4, mention that static storage or _init() is needed.
This commit is contained in:
Ryan Lortie 2011-10-02 23:37:20 -04:00
parent c5634df6d3
commit 65056180dd
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
glib/gthread.c
View File

@ -289,6 +289,10 @@
* </programlisting> * </programlisting>
* </example> * </example>
* *
* If a #GMutex is allocated in static storage then it can be used
* without initialisation. Otherwise, you should call g_mutex_init() on
* it and g_mutex_clear() when done.
*
* A statically initialized #GMutex provides an even simpler and safer * A statically initialized #GMutex provides an even simpler and safer
* way of doing this: * way of doing this:
* *
@ -326,6 +330,10 @@
* thread without deadlock. When doing so, care has to be taken to * thread without deadlock. When doing so, care has to be taken to
* unlock the recursive mutex as often as it has been locked. * unlock the recursive mutex as often as it has been locked.
* *
* If a #GRecMutex is allocated in static storage then it can be used
* without initialisation. Otherwise, you should call
* g_rec_mutex_init() on it and g_rec_mutex_clear() when done.
*
* A GRecMutex should only be accessed with the * A GRecMutex should only be accessed with the
* <function>g_rec_mutex_</function> functions. * <function>g_rec_mutex_</function> functions.
* *
@ -396,6 +404,10 @@
* </para> * </para>
* </example> * </example>
* *
* If a #GRWLock is allocated in static storage then it can be used
* without initialisation. Otherwise, you should call
* g_rw_lock_init() on it and g_rw_lock_clear() when done.
*
* A GRWLock should only be accessed with the * A GRWLock should only be accessed with the
* <function>g_rw_lock_</function> functions. * <function>g_rw_lock_</function> functions.
* *
@ -461,6 +473,10 @@
* to be woken up, even if the condition itself is protected by a * to be woken up, even if the condition itself is protected by a
* #GMutex, like above.</para></note> * #GMutex, like above.</para></note>
* *
* If a #GCond is allocated in static storage then it can be used
* without initialisation. Otherwise, you should call g_cond_init() on
* it and g_cond_clear() when done.
*
* A #GCond should only be accessed via the <function>g_cond_</function> * A #GCond should only be accessed via the <function>g_cond_</function>
* functions. * functions.
*/ */