Add a warning about g_thread_init invalidating timers. (#491218)

* glib/tmpl/timers.sgml: Add a warning about g_thread_init
invalidating timers. (#491218)

svn path=/trunk/; revision=6197

diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index a363f001905768f5ad41e77691701505db76be4e..85f7b9eece32fda282bb429225b33a86ddff5ba3 100644 (file)
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,3 +1,8 @@
+2007-12-24  Benjamin Otte  <otte@gnome.org>
+
+       * glib/tmpl/timers.sgml: Add a warning about g_thread_init
+       invalidating timers. (#491218)
+
 2007-12-24  Mathias Hasselmann  <mathias@openismus.com>
 
        Fix typo in g_try_new0 docs (#505195, Felix Riemann).

diff --git a/docs/reference/glib/tmpl/timers.sgml b/docs/reference/glib/tmpl/timers.sgml
index 04a1f79715d11f82a5fb79bdbd8d4aa5e67ebbcc..d346e3f13424daa7235b5a53c6c575b2af672a79 100644 (file)
--- a/docs/reference/glib/tmpl/timers.sgml
+++ b/docs/reference/glib/tmpl/timers.sgml
@@ -71,6 +71,9 @@ started. If @timer has been stopped, obtains the elapsed time between the time
 it was started and the time it was stopped. The return value is the number of
 seconds elapsed, including any fractional part. The @microseconds
 out parameter is essentially useless.
+<warning><para>Calling initialization functions, in particular g_thread_init(),
+while a timer is running will cause invalid return values from this function.
+</para></warning>
 </para>
 
 @timer: a #GTimer.