diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index c2c1b2e4d..6cc3bc91f 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,3 +1,8 @@ +2004-11-28 Tor Lillqvist + + * glib/tmpl/misc_utils.sgml: Document encoding of g_get_user_name(), + g_get_real_name(), g_get_tmp_dir() and g_get_current_dir(). + 2004-11-28 Matthias Clasen * glib/tmpl/macros_misc.sgml: Document G_GNUC_MALLOC. diff --git a/docs/reference/glib/tmpl/misc_utils.sgml b/docs/reference/glib/tmpl/misc_utils.sgml index 2d6616907..9511f09a0 100644 --- a/docs/reference/glib/tmpl/misc_utils.sgml +++ b/docs/reference/glib/tmpl/misc_utils.sgml @@ -82,7 +82,10 @@ reasons this function can only be called once. -Gets the user name of the current user. +Gets the user name of the current user. The encoding of the returned +string is system defined. On Unix, it might be the preferred file name +encoding, or something else, and there is no guarantee that it is even +consistent on a machine. On Windows, it is always UTF-8. @Returns: the user name of the current user. @@ -92,8 +95,8 @@ Gets the user name of the current user. Gets the real name of the user. This usually comes from the user's entry in the passwd file. The encoding of the returned string is system -defined. If the real user name cannot be determined, the string "Unknown" is -returned. +defined. (On Windows, it is, however, always UTF-8.) If the real user name +cannot be determined, the string "Unknown" is returned. @Returns: the user's real name. @@ -158,7 +161,8 @@ Gets the directory to use for temporary files. This is found from inspecting the environment variables TMPDIR, TMP, and TEMP in that order. If none of those are defined "/tmp" is returned on UNIX and -"C:\" on Windows. +"C:\" on Windows. The encoding of the returned string is system defined. On +Windows, it is always UTF-8. The return value is never NULL. @Returns: the directory to use for temporary files. @@ -167,7 +171,8 @@ in that order. If none of those are defined "/tmp" is returned on UNIX and Gets the current directory. -The returned string should be freed when no longer needed. +The returned string should be freed when no longer needed. The encoding of the +returned string is system defined. On Windows, it is always UTF-8. @Returns: the current directory.