document non-thread-safety for _foreach() functions.

Sat Jul 30 23:40:35 2005  Tim Janik  <timj@gtk.org>

        * glib/tmpl/datalist.sgml:
        * glib/tmpl/datalset.sgml: document non-thread-safety for
        _foreach() functions.

diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index a8d3ec4..0d0907e 100644 (file)
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,3 +1,9 @@
+Sat Jul 30 23:40:35 2005  Tim Janik  <timj@gtk.org>
+
+       * glib/tmpl/datalist.sgml:
+       * glib/tmpl/datalset.sgml: document non-thread-safety for 
+       _foreach() functions.
+
 2005-07-26  Matthias Clasen  <mclasen@redhat.com>
 
        * glib/tmpl/arrays.sgml: One more improvement.

diff --git a/docs/reference/glib/tmpl/datalist.sgml b/docs/reference/glib/tmpl/datalist.sgml
index c2690ea..515c3fe 100644 (file)
--- a/docs/reference/glib/tmpl/datalist.sgml
+++ b/docs/reference/glib/tmpl/datalist.sgml
@@ -32,7 +32,7 @@ To get data elements from a datalist use g_datalist_id_get_data() and
 g_datalist_get_data().
 </para>
 <para>
-To iterate over all data elements in a datalist use g_datalist_foreach().
+To iterate over all data elements in a datalist use g_datalist_foreach() (not thread-safe).
 </para>
 <para>
 To remove data elements from a datalist use g_datalist_id_remove_data() and
@@ -189,6 +189,9 @@ Removes an element, without calling its destroy notifier.
 Calls the given function for each data element of the datalist.
 The function is called with each data element's #GQuark id and data,
 together with the given @user_data parameter.
+Note that this function is NOT thread-safe. So unless @datalist
+can be protected from any modifications during invokation of this
+function, it should not be called.
 </para>
 
 @datalist: a datalist.

diff --git a/docs/reference/glib/tmpl/datasets.sgml b/docs/reference/glib/tmpl/datasets.sgml
index 815294c..48b52ad 100644 (file)
--- a/docs/reference/glib/tmpl/datasets.sgml
+++ b/docs/reference/glib/tmpl/datasets.sgml
@@ -34,7 +34,7 @@ To get data elements from a dataset use g_dataset_id_get_data() and
 g_dataset_get_data().
 </para>
 <para>
-To iterate over all data elements in a dataset use g_dataset_foreach().
+To iterate over all data elements in a dataset use g_dataset_foreach() (not thread-safe).
 </para>
 <para>
 To remove data elements from a dataset use g_dataset_id_remove_data() and
@@ -179,6 +179,9 @@ Removes an element, without calling its destroy notifier.
 <para>
 Calls the given function for each data element which is associated with the
 given location.
+Note that this function is NOT thread-safe. So unless @datalist
+can be protected from any modifications during invokation of this
+function, it should not be called.
 </para>
 
 @dataset_location: the location identifying the dataset.