Deprecate g_cache_value_foreach. (#322956, Nicolas Caniart)

2005-12-03 Matthias Clasen <mclasen@redhat.com> * glib/glib.symbols: * glib/gcache.h: Deprecate g_cache_value_foreach. (#322956, Nicolas Caniart)
dieterv · Dec 3, 2005 · 36c8364 · 36c8364
1 parent d87c91a
commit 36c8364
Show file tree

Hide file tree

Showing 7 changed files with 27 additions and 1 deletion.
diff --git a/ChangeLog b/ChangeLog
@@ -1,5 +1,9 @@
 2005-12-03  Matthias Clasen  <mclasen@redhat.com>
 
+	* glib/glib.symbols: 
+	* glib/gcache.h: Deprecate g_cache_value_foreach. (#322956,
+	Nicolas Caniart)
+
 	* glib/gmappedfile.c: Make mapping of empty files
 	work.  (#321530)
 

diff --git a/ChangeLog.pre-2-10 b/ChangeLog.pre-2-10
@@ -1,5 +1,9 @@
 2005-12-03  Matthias Clasen  <mclasen@redhat.com>
 
+	* glib/glib.symbols: 
+	* glib/gcache.h: Deprecate g_cache_value_foreach. (#322956,
+	Nicolas Caniart)
+
 	* glib/gmappedfile.c: Make mapping of empty files
 	work.  (#321530)
 

diff --git a/ChangeLog.pre-2-12 b/ChangeLog.pre-2-12
@@ -1,5 +1,9 @@
 2005-12-03  Matthias Clasen  <mclasen@redhat.com>
 
+	* glib/glib.symbols: 
+	* glib/gcache.h: Deprecate g_cache_value_foreach. (#322956,
+	Nicolas Caniart)
+
 	* glib/gmappedfile.c: Make mapping of empty files
 	work.  (#321530)
 

diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
@@ -1,5 +1,8 @@
 2005-12-03  Matthias Clasen  <mclasen@redhat.com>
-
+
+	* glib/tmpl/caches.sgml: Document g_cache_value_foreach
+	as deprecated; document g_cache_key_foreach more thorougly
+
 	* glib/glib-sections.txt:
 	* glib/tmpl/linked_lists_single.sgml: Add g_slist_free1.
 

diff --git a/docs/reference/glib/tmpl/caches.sgml b/docs/reference/glib/tmpl/caches.sgml
@@ -104,6 +104,11 @@ Note that it does not destroy the keys and values which were contained in the
 <para>
 Calls the given function for each of the keys in the #GCache.
 </para>
+<note><para>@func is passed three parameters, the value and key of a
+cache entry and the @user_data. The order of value and key is different
+from the order in which g_hash_table_foreach() passes key-value pairs
+to its callback function !
+</para></note>
 
 @cache: a #GCache.
 @func: the function to call with each #GCache key.
@@ -118,6 +123,8 @@ Calls the given function for each of the values in the #GCache.
 @cache: a #GCache.
 @func: the function to call with each #GCache value.
 @user_data: user data to pass to the function.
+@Deprecated: Since it passes pointers to internal data structures
+to @func; use g_cache_key_foreach() instead
 
 
 <!-- ##### USER_FUNCTION GCacheDestroyFunc ##### -->

diff --git a/glib/gcache.h b/glib/gcache.h
@@ -54,9 +54,11 @@ void     g_cache_remove        (GCache            *cache,
 void     g_cache_key_foreach   (GCache            *cache,
                                 GHFunc             func,
                                 gpointer           user_data);
+#ifndef G_DISABLE_DEPRECATED
 void     g_cache_value_foreach (GCache            *cache,
                                 GHFunc             func,
                                 gpointer           user_data);
+#endif
 
 G_END_DECLS
 

diff --git a/glib/glib.symbols b/glib/glib.symbols
@@ -104,9 +104,11 @@ g_cache_insert
 g_cache_key_foreach
 g_cache_new
 g_cache_remove
+#ifndef G_DISABLE_DEPRECATED
 g_cache_value_foreach
 #endif
 #endif
+#endif
 
 #if IN_HEADER(__G_COMPLETION_H__)
 #if IN_FILE(__G_COMPLETION_C__)