diff options
| author | Tim Janik <timj@imendio.com> | 2007-07-12 13:46:22 +0000 |
|---|---|---|
| committer | Tim Janik <timj@src.gnome.org> | 2007-07-12 13:46:22 +0000 |
| commit | 64acb3186250ef53d64038aae1560dcaf76753d1 (patch) | |
| tree | 7a78f91932ec5d7160a846c9c5e01c145b53bf4c | |
| parent | 86fe2d770a92306fc606aaa61200f5195eb3dd9a (diff) | |
document major caveat of g_private_set/g_private_get, i.e. not retaining
Thu Jul 12 15:45:27 2007 Tim Janik <timj@imendio.com>
* glib/tmpl/threads.sgml: document major caveat of g_private_set/g_private_get,
i.e. not retaining private data across g_thread_init.
svn path=/trunk/; revision=5628
| -rw-r--r-- | docs/reference/ChangeLog | 5 | ||||
| -rw-r--r-- | docs/reference/glib/tmpl/threads.sgml | 9 |
2 files changed, 12 insertions, 2 deletions
diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index 1a869b261..de811a19f 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,3 +1,8 @@ +Thu Jul 12 15:45:27 2007 Tim Janik <timj@imendio.com> + + * glib/tmpl/threads.sgml: document major caveat of g_private_set/g_private_get, + i.e. not retaining private data across g_thread_init. + Tue Jul 10 13:11:55 2007 Tim Janik <timj@imendio.com> * glib/tmpl/types.sgml: corrected descriptions of gsize and gssize. diff --git a/docs/reference/glib/tmpl/threads.sgml b/docs/reference/glib/tmpl/threads.sgml index fa4392d26..6b177cd3c 100644 --- a/docs/reference/glib/tmpl/threads.sgml +++ b/docs/reference/glib/tmpl/threads.sgml @@ -1506,8 +1506,12 @@ current @private_key and thread yet, this pointer will be %NULL. </para> <para> -This function can be used even if g_thread_init() has not yet been -called, and, in that case, will return the value of @private_key casted to #gpointer. +This function can be used even if g_thread_init() has not yet been called, and, +in that case, will return the value of @private_key casted to #gpointer. +Note however, that private data set <emphasis>before</emphasis> g_thread_init() will +<emphasis>not</emphasis> be retained <emphasis>after</emphasis> the call. Instead, %NULL +will be returned in all threads directly after g_thread_init(), regardless of +any g_private_set() calls issued before threading system intialization. </para> @private_key: a #GPrivate. @@ -1523,6 +1527,7 @@ Sets the pointer keyed to @private_key for the current thread. <para> This function can be used even if g_thread_init() has not yet been called, and, in that case, will set @private_key to @data casted to #GPrivate*. +See g_private_get() for resulting caveats. </para> @private_key: a #GPrivate. |