[glib] Bug 679467 — Mention translation in g_warning() documentation

[Philip Withnall <pwithnall src gnome org>]

commit 8330b09d781ebc8bb27f08ce24a0e073b39e8ab4
Author: Philip Withnall <philip tecnocode co uk>
Date:   Thu Jul 5 20:32:19 2012 +0100

    Bug 679467 — Mention translation in g_warning() documentation
    
    Include a line in the documentation for g_warning(), g_error(), g_critical()
    and g_debug() mentioning that the messages passed to them typically should not
    be translated.
    
    Closes: https://bugzilla.gnome.org/show_bug.cgi?id=679467

 glib/gmessages.c |   12 +++++++++---
 1 files changed, 9 insertions(+), 3 deletions(-)
---
diff --git a/glib/gmessages.c b/glib/gmessages.c
index 919bd43..d97da90 100644
--- a/glib/gmessages.c
+++ b/glib/gmessages.c
@@ -371,7 +371,8 @@ myInvalidParameterHandler(const wchar_t *expression,
  * @...: format string, followed by parameters to insert
  *     into the format string (as with printf())
  *
- * A convenience function/macro to log a warning message.
+ * A convenience function/macro to log a warning message. The message should
+ * typically *not* be translated to the user's language.
  *
  * This is not intended for end user error reporting. Use of #GError is
  * preferred for that instead, as it allows calling functions to perform actions
@@ -406,6 +407,9 @@ myInvalidParameterHandler(const wchar_t *expression,
  * setting the `G_DEBUG` environment variable (see
  * [Running GLib Applications](glib-running.html)).
  *
+ * The message should typically *not* be translated to the
+ * user's language.
+ *
  * If g_log_default_handler() is used as the log handler function, a new-line
  * character will automatically be appended to @..., and need not be entered
  * manually.
@@ -420,7 +424,8 @@ myInvalidParameterHandler(const wchar_t *expression,
  * @...: format string, followed by parameters to insert
  *     into the format string (as with printf())
  *
- * A convenience function/macro to log an error message.
+ * A convenience function/macro to log an error message. The message should
+ * typically *not* be translated to the user's language.
  *
  * This is not intended for end user error reporting. Use of #GError is
  * preferred for that instead, as it allows calling functions to perform actions
@@ -468,7 +473,8 @@ myInvalidParameterHandler(const wchar_t *expression,
  * @...: format string, followed by parameters to insert
  *     into the format string (as with printf())
  *
- * A convenience function/macro to log a debug message.
+ * A convenience function/macro to log a debug message. The message should
+ * typically *not* be translated to the user's language.
  *
  * If g_log_default_handler() is used as the log handler function, a new-line
  * character will automatically be appended to @..., and need not be entered