From b6b00bab53cc37332eff4b1133885d74924544c0 Mon Sep 17 00:00:00 2001 From: Sebastian Wilhelmi Date: Fri, 27 Oct 2000 12:34:49 +0000 Subject: [PATCH] Document the recently deprecated functions as such. 2000-10-27 Sebastian Wilhelmi * 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. --- docs/reference/ChangeLog | 7 +++++ docs/reference/glib/glib-sections.txt | 2 +- docs/reference/glib/tmpl/hash_tables.sgml | 16 ++++------ docs/reference/glib/tmpl/macros_misc.sgml | 1 - docs/reference/glib/tmpl/misc_utils.sgml | 36 ++++++++++++++++++----- docs/reference/glib/tmpl/scanner.sgml | 6 ++-- 6 files changed, 47 insertions(+), 21 deletions(-) diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index 8bab7cae..8a461786 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,3 +1,10 @@ +2000-10-27 Sebastian Wilhelmi + + * 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 'make distcheck' fixes. diff --git a/docs/reference/glib/glib-sections.txt b/docs/reference/glib/glib-sections.txt index 66204f03..2a54daeb 100644 --- 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 75ffd060..33c9abdb 100644 --- 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 -Disable resizing of a #GHashTable. - - -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. -@hash_table: a #GHashTable. +@hash_table: -Enables resizing of a #GHashTable. +This function is deprecated and will be removed in the next major +release of GLib. It does nothing. -@hash_table: a #GHashTable. +@hash_table: diff --git a/docs/reference/glib/tmpl/macros_misc.sgml b/docs/reference/glib/tmpl/macros_misc.sgml index 06912edb..b2758183 100644 --- 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 va_list variables. - @ap1: the va_list variable to place a copy of @ap2 in. @ap2: a va_list. diff --git a/docs/reference/glib/tmpl/misc_utils.sgml b/docs/reference/glib/tmpl/misc_utils.sgml index e9eadd9c..3ad04db2 100644 --- 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. -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. + + + +Gets the name of the file without any leading +directory components. It returns a pointer into the given file name +string. @file_name: the name of the file. @@ -100,6 +106,11 @@ 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_dirname() instead. + + 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. - +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. -@file_name: -@Returns: +@file_name: the name of the file. +@Returns: the directory components of the file. +Gets the name of the file without any leading directory components. +The returned string should be freed when no longer needed. + + + +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. + -@file_name: -@Returns: +@file_name: the name of the file. +@Returns: the name of the file without any leading directory components. diff --git a/docs/reference/glib/tmpl/scanner.sgml b/docs/reference/glib/tmpl/scanner.sgml index 2e02cb3a..9ba7a3d4 100644 --- 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. - +This function is deprecated and will be removed in the next major +release of GLib. It does nothing. @scanner: @@ -316,7 +317,8 @@ Adds a symbol to the given scope. - +This function is deprecated and will be removed in the next major +release of GLib. It does nothing. @scanner: -- 2.34.1