Document the recently deprecated functions as such.

2000-10-27  Sebastian Wilhelmi  <wilhelmi@ira.uka.de>

	* glib/glib-sections.txt, glib/tmpl/hash_tables.sgml,
	glib/tmpl/macros_misc.sgml, glib/tmpl/misc_utils.sgml,
	glib/tmpl/scanner.sgml: Document the recently deprecated functions
	as such.

diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index 8bab7cae54f17a4e0ddb2161444190320e9cc55e..8a461786f59f4426f14e04efb50cf343987a04d9 100644 (file)
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,3 +1,10 @@
+2000-10-27  Sebastian Wilhelmi  <wilhelmi@ira.uka.de>
+
+       * glib/glib-sections.txt, glib/tmpl/hash_tables.sgml,
+       glib/tmpl/macros_misc.sgml, glib/tmpl/misc_utils.sgml,
+       glib/tmpl/scanner.sgml: Document the recently deprecated functions
+       as such.
+
 2000-10-15  Raja R Harinath  <harinath@cs.umn.edu>
 
        'make distcheck' fixes.

diff --git a/docs/reference/glib/glib-sections.txt b/docs/reference/glib/glib-sections.txt
index 66204f03e9a6fd4cc4c8c4b0edcd2f7790fae82e..2a54daeb288fb250d2f5d1a7b02772dff8d87e52 100644 (file)
--- a/docs/reference/glib/glib-sections.txt
+++ b/docs/reference/glib/glib-sections.txt
@@ -883,8 +883,8 @@ g_basename
 g_dirname
 g_path_is_absolute
 g_path_skip_root
-g_path_get_dirname
 g_path_get_basename
+g_path_get_dirname
 g_filename_to_utf8
 g_filename_from_utf8
 

diff --git a/docs/reference/glib/tmpl/hash_tables.sgml b/docs/reference/glib/tmpl/hash_tables.sgml
index 75ffd0600ee88f81e32cb3e8be418a13631d962e..33c9abdb976b88c41f71ef9dcc874f9fba91e29b 100644 (file)
--- a/docs/reference/glib/tmpl/hash_tables.sgml
+++ b/docs/reference/glib/tmpl/hash_tables.sgml
@@ -252,24 +252,20 @@ It should return TRUE if the key/value pair should be removed from the
 
 <!-- ##### FUNCTION g_hash_table_freeze ##### -->
 <para>
-Disable resizing of a #GHashTable.
-</para>
-<para>
-This should be used if you need to make a lot of changes to a #GHashTable
-at once, as it reduces the number of times that the #GHashTable is rebuilt.
-You should call g_hash_table_thaw() after updating the #GHashTable to
-enable resizing again.
+This function is deprecated and will be removed in the next major
+release of GLib. It does nothing.
 </para>
 
-@hash_table: a #GHashTable.
+@hash_table: 
 
 
 <!-- ##### FUNCTION g_hash_table_thaw ##### -->
 <para>
-Enables resizing of a #GHashTable.
+This function is deprecated and will be removed in the next major
+release of GLib. It does nothing.
 </para>
 
-@hash_table: a #GHashTable.
+@hash_table: 
 
 
 <!-- ##### FUNCTION g_hash_table_destroy ##### -->

diff --git a/docs/reference/glib/tmpl/macros_misc.sgml b/docs/reference/glib/tmpl/macros_misc.sgml
index 06912edb867c686a77e0f29bdaea2b804564cfd5..b27581833505264af24c91e9552c977e5ec395e1 100644 (file)
--- a/docs/reference/glib/tmpl/macros_misc.sgml
+++ b/docs/reference/glib/tmpl/macros_misc.sgml
@@ -66,7 +66,6 @@ only one statement is expected by the compiler.
 Portable way to copy <type>va_list</type> variables.
 </para>
 
-<!-- # Unused Parameters # -->
 @ap1: the <type>va_list</type> variable to place a copy of @ap2 in.
 @ap2: a <type>va_list</type>.
 

diff --git a/docs/reference/glib/tmpl/misc_utils.sgml b/docs/reference/glib/tmpl/misc_utils.sgml
index e9eadd9ca2acaa35f92522451b664367d36fde68..3ad04db212fa8398ff1277ca808594c99cdd9691 100644 (file)
--- a/docs/reference/glib/tmpl/misc_utils.sgml
+++ b/docs/reference/glib/tmpl/misc_utils.sgml
@@ -91,8 +91,14 @@ The returned string should be freed when no longer needed.
 
 <!-- ##### FUNCTION g_basename ##### -->
 <para>
-Gets the name of the file without any leading directory components.
-It returns a pointer into the given file name string.
+This function is deprecated and will be removed in the next major
+release of GLib. Use g_path_get_basename() instead. 
+</para>
+
+<para>
+Gets the name of the file without any leading
+directory components.  It returns a pointer into the given file name
+string.
 </para>
 
 @file_name: the name of the file.
@@ -100,6 +106,11 @@ It returns a pointer into the given file name string.
 
 
 <!-- ##### FUNCTION g_dirname ##### -->
+<para>
+This function is deprecated and will be removed in the next major
+release of GLib. Use g_path_get_dirname() instead.
+</para>
+
 <para>
 Gets the directory components of a file name.
 If the file name has no directory components "." is returned.
@@ -134,20 +145,31 @@ path it returns NULL.
 
 <!-- ##### FUNCTION g_path_get_dirname ##### -->
 <para>
-
+Gets the directory components of a file name.  If the file name has no
+directory components "." is returned.  The returned string should be
+freed when no longer needed.
 </para>
 
-@file_name: 
-@Returns: 
+@file_name: the name of the file.
+@Returns: the directory components of the file.
 
 
 <!-- ##### FUNCTION g_path_get_basename ##### -->
 <para>
+Gets the name of the file without any leading directory components.
+The returned string should be freed when no longer needed.
+</para>
 
+<note>
+<para>
+This function allocates new memory for the returned string. This is
+different from the old g_basename() function, which returned a pointer
+into the argument.
 </para>
+</note>
 
-@file_name: 
-@Returns: 
+@file_name: the name of the file.
+@Returns: the name of the file without any leading directory components.
 
 
 <!-- ##### FUNCTION g_filename_to_utf8 ##### -->

diff --git a/docs/reference/glib/tmpl/scanner.sgml b/docs/reference/glib/tmpl/scanner.sgml
index 2e02cb3a502455347b575093b716c0ed47d25de3..9ba7a3d4f17cd8ee4931bf2273c0ef815efadb44 100644 (file)
--- a/docs/reference/glib/tmpl/scanner.sgml
+++ b/docs/reference/glib/tmpl/scanner.sgml
@@ -308,7 +308,8 @@ Adds a symbol to the given scope.
 
 <!-- ##### FUNCTION g_scanner_freeze_symbol_table ##### -->
 <para>
-
+This function is deprecated and will be removed in the next major
+release of GLib. It does nothing.
 </para>
 
 @scanner: 
@@ -316,7 +317,8 @@ Adds a symbol to the given scope.
 
 <!-- ##### FUNCTION g_scanner_thaw_symbol_table ##### -->
 <para>
-
+This function is deprecated and will be removed in the next major
+release of GLib. It does nothing.
 </para>
 
 @scanner: