Add Windows notes to doc comment.

2006-06-14  Tor Lillqvist  <tml@novell.com>

	* glib/gutils.c (g_listenv): Add Windows notes to doc comment.

diff --git a/ChangeLog b/ChangeLog
index 3411734..4475597 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,7 @@
+2006-06-14  Tor Lillqvist  <tml@novell.com>
+
+       * glib/gutils.c (g_listenv): Add Windows notes to doc comment.
+
 2006-06-12  Emmanuele Bassi  <ebassi@cvs.gnome.org>
 
        * glib/gbookmarkfile.h:

diff --git a/ChangeLog.pre-2-12 b/ChangeLog.pre-2-12
index 3411734..4475597 100644 (file)
--- a/ChangeLog.pre-2-12
+++ b/ChangeLog.pre-2-12
@@ -1,3 +1,7 @@
+2006-06-14  Tor Lillqvist  <tml@novell.com>
+
+       * glib/gutils.c (g_listenv): Add Windows notes to doc comment.
+
 2006-06-12  Emmanuele Bassi  <ebassi@cvs.gnome.org>
 
        * glib/gbookmarkfile.h:

diff --git a/glib/gutils.c b/glib/gutils.c
index b448260..7924857 100644 (file)
--- a/glib/gutils.c
+++ b/glib/gutils.c
@@ -1399,6 +1399,13 @@ g_unsetenv (const gchar *variable)
  * Returns: a %NULL-terminated list of strings which must be freed
  * with g_strfreev().
  *
+ * Programs that want to be portable to Windows should typically use
+ * this function and g_getenv() instead of using the environ array
+ * from the C library directly. On Windows, the strings in the environ
+ * array are in system codepage encoding, while in most of the typical
+ * use cases for environment variables in GLib-using programs you want
+ * the UTF-8 encoding that this function and g_getenv() provide.
+ *
  * Since: 2.8
  */
 gchar **