Improve g_strerror and g_strsignal docs. Bug #438293.

2007-05-14  Christian Persch  <chpe@gnome.org>

	* docs/reference/glib/tmpl/string_utils.sgml: Improve g_strerror and
	g_strsignal docs. Bug #438293.

svn path=/trunk/; revision=5491

diff --git a/ChangeLog b/ChangeLog
index 3a86ee0..ff2f86d 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2007-05-14  Christian Persch  <chpe@gnome.org>
+
+       * docs/reference/glib/tmpl/string_utils.sgml: Improve g_strerror and
+       g_strsignal docs. Bug #438293.
+
 2007-05-13  Tor Lillqvist  <tml@novell.com>
 
        * glib/gwin32.h: Drop the pipe() macro. Defining macros outside of

diff --git a/docs/reference/glib/tmpl/string_utils.sgml b/docs/reference/glib/tmpl/string_utils.sgml
index cf35e12..0ab262d 100644 (file)
--- a/docs/reference/glib/tmpl/string_utils.sgml
+++ b/docs/reference/glib/tmpl/string_utils.sgml
@@ -913,13 +913,14 @@ together, with @separator between them.
 <!-- ##### FUNCTION g_strerror ##### -->
 <para>
 Returns a string corresponding to the given error code, e.g. "no such process".
-This function is included since not all platforms support the 
+You should use this function in preference to strerror(), because it returns a
+string in UTF-8 encoding, and since not all platforms support the 
 strerror() function.
 </para>
 
 @errnum: the system error number. See the standard C %errno
 documentation.
-@Returns: a string describing the error code.
+@Returns: a UTF-8 string describing the error code.
 If the error code is unknown, it returns "unknown error (&lt;code&gt;)".
 The string can only be used until the next call to g_strerror().
 
@@ -927,13 +928,14 @@ The string can only be used until the next call to g_strerror().
 <!-- ##### FUNCTION g_strsignal ##### -->
 <para>
 Returns a string describing the given signal, e.g. "Segmentation fault".
-This function is included since not all platforms support the
+You should use this function in preference to strsignal(), because it returns a
+string in UTF-8 encoding, and since not all platforms support the
 strsignal() function.
 </para>
 
 @signum: the signal number. See the <literal>signal</literal>
 documentation.
-@Returns: a string describing the signal.
+@Returns: a UTF-8 string describing the signal.
 If the signal is unknown, it returns "unknown signal (&lt;signum&gt;)".
 The string can only be used until the next call to g_strsignal().