mention the fact that the tree is traversed in sorted order.

2001-12-05  Sven Neumann  <sven@gimp.org>

	* glib/gtree.c (g_tree_foreach): mention the fact that the tree is
	traversed in sorted order.

9 files changed, 48 insertions, 7 deletions

diff --git a/ChangeLog b/ChangeLog
index 8dbbf6044..2e562abaa 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2001-12-05  Sven Neumann  <sven@gimp.org>
+
+	* glib/gtree.c (g_tree_foreach): mention the fact that the tree is
+	traversed in sorted order.
+
 2001-12-03  Manish Singh  <yosh@gimp.org>
 
 	* tests/module-test.c: g_module_symbol takes a gpointer *, not just
diff --git a/ChangeLog.pre-2-0 b/ChangeLog.pre-2-0
index 8dbbf6044..2e562abaa 100644
--- a/ChangeLog.pre-2-0
+++ b/ChangeLog.pre-2-0
@@ -1,3 +1,8 @@
+2001-12-05  Sven Neumann  <sven@gimp.org>
+
+	* glib/gtree.c (g_tree_foreach): mention the fact that the tree is
+	traversed in sorted order.
+
 2001-12-03  Manish Singh  <yosh@gimp.org>
 
 	* tests/module-test.c: g_module_symbol takes a gpointer *, not just
diff --git a/ChangeLog.pre-2-10 b/ChangeLog.pre-2-10
index 8dbbf6044..2e562abaa 100644
--- a/ChangeLog.pre-2-10
+++ b/ChangeLog.pre-2-10
@@ -1,3 +1,8 @@
+2001-12-05  Sven Neumann  <sven@gimp.org>
+
+	* glib/gtree.c (g_tree_foreach): mention the fact that the tree is
+	traversed in sorted order.
+
 2001-12-03  Manish Singh  <yosh@gimp.org>
 
 	* tests/module-test.c: g_module_symbol takes a gpointer *, not just
diff --git a/ChangeLog.pre-2-12 b/ChangeLog.pre-2-12
index 8dbbf6044..2e562abaa 100644
--- a/ChangeLog.pre-2-12
+++ b/ChangeLog.pre-2-12
@@ -1,3 +1,8 @@
+2001-12-05  Sven Neumann  <sven@gimp.org>
+
+	* glib/gtree.c (g_tree_foreach): mention the fact that the tree is
+	traversed in sorted order.
+
 2001-12-03  Manish Singh  <yosh@gimp.org>
 
 	* tests/module-test.c: g_module_symbol takes a gpointer *, not just
diff --git a/ChangeLog.pre-2-2 b/ChangeLog.pre-2-2
index 8dbbf6044..2e562abaa 100644
--- a/ChangeLog.pre-2-2
+++ b/ChangeLog.pre-2-2
@@ -1,3 +1,8 @@
+2001-12-05  Sven Neumann  <sven@gimp.org>
+
+	* glib/gtree.c (g_tree_foreach): mention the fact that the tree is
+	traversed in sorted order.
+
 2001-12-03  Manish Singh  <yosh@gimp.org>
 
 	* tests/module-test.c: g_module_symbol takes a gpointer *, not just
diff --git a/ChangeLog.pre-2-4 b/ChangeLog.pre-2-4
index 8dbbf6044..2e562abaa 100644
--- a/ChangeLog.pre-2-4
+++ b/ChangeLog.pre-2-4
@@ -1,3 +1,8 @@
+2001-12-05  Sven Neumann  <sven@gimp.org>
+
+	* glib/gtree.c (g_tree_foreach): mention the fact that the tree is
+	traversed in sorted order.
+
 2001-12-03  Manish Singh  <yosh@gimp.org>
 
 	* tests/module-test.c: g_module_symbol takes a gpointer *, not just
diff --git a/ChangeLog.pre-2-6 b/ChangeLog.pre-2-6
index 8dbbf6044..2e562abaa 100644
--- a/ChangeLog.pre-2-6
+++ b/ChangeLog.pre-2-6
@@ -1,3 +1,8 @@
+2001-12-05  Sven Neumann  <sven@gimp.org>
+
+	* glib/gtree.c (g_tree_foreach): mention the fact that the tree is
+	traversed in sorted order.
+
 2001-12-03  Manish Singh  <yosh@gimp.org>
 
 	* tests/module-test.c: g_module_symbol takes a gpointer *, not just
diff --git a/ChangeLog.pre-2-8 b/ChangeLog.pre-2-8
index 8dbbf6044..2e562abaa 100644
--- a/ChangeLog.pre-2-8
+++ b/ChangeLog.pre-2-8
@@ -1,3 +1,8 @@
+2001-12-05  Sven Neumann  <sven@gimp.org>
+
+	* glib/gtree.c (g_tree_foreach): mention the fact that the tree is
+	traversed in sorted order.
+
 2001-12-03  Manish Singh  <yosh@gimp.org>
 
 	* tests/module-test.c: g_module_symbol takes a gpointer *, not just
diff --git a/glib/gtree.c b/glib/gtree.c
index 0546246cd..ceea2f866 100644
--- a/glib/gtree.c
+++ b/glib/gtree.c
@@ -442,11 +442,12 @@ g_tree_lookup_extended (GTree         *tree,
  * 
  * Calls the given function for each of the key/value pairs in the #GTree.
  * The function is passed the key and value of each pair, and the given
- * @data parameter. The tree may not be modified while iterating over
- * it (you can't add/remove items). To remove all items matching
- * a predicate, you need to add each item to a list as in your
- * #GTraverseFunc as you walk over the tree, then walk the list
- * and remove each item.
+ * @data parameter. The tree is traversed in sorted order.
+ *
+ * The tree may not be modified while iterating over it (you can't 
+ * add/remove items). To remove all items matching a predicate, you need 
+ * to add each item to a list in your #GTraverseFunc as you walk over 
+ * the tree, then walk the list and remove each item.
  **/
 void
 g_tree_foreach (GTree         *tree,
@@ -472,8 +473,8 @@ g_tree_foreach (GTree         *tree,
  * 
  * Calls the given function for each node in the GTree. This function is
  * deprecated, since the order of a balanced tree is somewhat arbitrary.
- * If you just want to visit all nodes in some order, use g_tree_foreach() 
- * instead. If you really need to visit nodes in a specific order, consider
+ * If you just want to visit all nodes in sorted order, use g_tree_foreach() 
+ * instead. If you really need to visit nodes in a different order, consider
  * using an <link linkend="glib-N-ary-Trees">N-ary Tree</link>.
  **/
 void