Clarify the relation of g_get_home_dir() and $HOME.

diff --git a/ChangeLog b/ChangeLog
index eb0458b..f91299f 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,7 @@
+2004-09-09  Matthias Clasen  <mclasen@redhat.com>
+
+       * glib/gutils.c (g_get_home_dir): Remove a misleading comment.
+
 Thu Sep  9 00:10:40 2004  Matthias Clasen  <maclas@gmx.de>
 
        * glib/gstrfuncs.h: 

diff --git a/ChangeLog.pre-2-10 b/ChangeLog.pre-2-10
index eb0458b..f91299f 100644 (file)
--- a/ChangeLog.pre-2-10
+++ b/ChangeLog.pre-2-10
@@ -1,3 +1,7 @@
+2004-09-09  Matthias Clasen  <mclasen@redhat.com>
+
+       * glib/gutils.c (g_get_home_dir): Remove a misleading comment.
+
 Thu Sep  9 00:10:40 2004  Matthias Clasen  <maclas@gmx.de>
 
        * glib/gstrfuncs.h: 

diff --git a/ChangeLog.pre-2-12 b/ChangeLog.pre-2-12
index eb0458b..f91299f 100644 (file)
--- a/ChangeLog.pre-2-12
+++ b/ChangeLog.pre-2-12
@@ -1,3 +1,7 @@
+2004-09-09  Matthias Clasen  <mclasen@redhat.com>
+
+       * glib/gutils.c (g_get_home_dir): Remove a misleading comment.
+
 Thu Sep  9 00:10:40 2004  Matthias Clasen  <maclas@gmx.de>
 
        * glib/gstrfuncs.h: 

diff --git a/ChangeLog.pre-2-6 b/ChangeLog.pre-2-6
index eb0458b..f91299f 100644 (file)
--- a/ChangeLog.pre-2-6
+++ b/ChangeLog.pre-2-6
@@ -1,3 +1,7 @@
+2004-09-09  Matthias Clasen  <mclasen@redhat.com>
+
+       * glib/gutils.c (g_get_home_dir): Remove a misleading comment.
+
 Thu Sep  9 00:10:40 2004  Matthias Clasen  <maclas@gmx.de>
 
        * glib/gstrfuncs.h: 

diff --git a/ChangeLog.pre-2-8 b/ChangeLog.pre-2-8
index eb0458b..f91299f 100644 (file)
--- a/ChangeLog.pre-2-8
+++ b/ChangeLog.pre-2-8
@@ -1,3 +1,7 @@
+2004-09-09  Matthias Clasen  <mclasen@redhat.com>
+
+       * glib/gutils.c (g_get_home_dir): Remove a misleading comment.
+
 Thu Sep  9 00:10:40 2004  Matthias Clasen  <maclas@gmx.de>
 
        * glib/gstrfuncs.h: 

diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index f66d1be..7485434 100644 (file)
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,3 +1,8 @@
+2004-09-09  Matthias Clasen  <mclasen@redhat.com>
+
+       * glib/tmpl/misc_utils.sgml: Add a hint about $HOME to the
+       docs of g_get_home_dir().
+
 Thu Sep  9 00:11:19 2004  Matthias Clasen  <maclas@gmx.de>
 
        * glib/glib-sections.txt: Add g_strv_length().

diff --git a/docs/reference/glib/tmpl/misc_utils.sgml b/docs/reference/glib/tmpl/misc_utils.sgml
index 5ba3487..8ead291 100644 (file)
--- a/docs/reference/glib/tmpl/misc_utils.sgml
+++ b/docs/reference/glib/tmpl/misc_utils.sgml
@@ -125,7 +125,12 @@ returned.
 
 <!-- ##### FUNCTION g_get_home_dir ##### -->
 <para>
-Gets the current user's home directory.
+Gets the current user's home directory. 
+</para>
+<para>
+Note that in contrast to traditional Unix tools, this function 
+prefers <filename>passwd</filename> entries over the <envar>HOME<envar> 
+environment variable.
 </para>
 
 @Returns: the current user's home directory.

diff --git a/glib/gutils.c b/glib/gutils.c
index c2fdf46..fe7d44a 100644 (file)
--- a/glib/gutils.c
+++ b/glib/gutils.c
@@ -1165,12 +1165,6 @@ g_get_real_name (void)
   return g_real_name;
 }
 
-/* Return the home directory of the user. If there is a HOME
- * environment variable, its value is returned, otherwise use some
- * system-dependent way of finding it out. If no home directory can be
- * deduced, return NULL.
- */
-
 G_CONST_RETURN gchar*
 g_get_home_dir (void)
 {