From fd91e6aa5bbe1b0e79c344953f5eaeb4f433cc27 Mon Sep 17 00:00:00 2001
From: Matthias Clasen <mclasen@redhat.com>
Date: Wed, 15 Mar 2006 13:46:49 +0000
Subject: [PATCH] Hint that @error should be set in error cases. (#334646,
 Christian Persch)

2006-03-15  Matthias Clasen  <mclasen@redhat.com>

	* glib/tmpl/option.sgml: Hint that @error should
	be set in error cases.  (#334646, Christian Persch)
---
 docs/reference/ChangeLog             | 5 +++++
 docs/reference/glib/tmpl/option.sgml | 9 ++++-----
 2 files changed, 9 insertions(+), 5 deletions(-)

diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index 6af238d78..abd6d1978 100644
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,3 +1,8 @@
+2006-03-15  Matthias Clasen  <mclasen@redhat.com>
+
+	* glib/tmpl/option.sgml: Hint that @error should
+	be set in error cases.  (#334646, Christian Persch)
+
 2006-03-09  Matthias Clasen  <mclasen@redhat.com>
 
 	* glib/templ/timers.sgml: Mention that the second
diff --git a/docs/reference/glib/tmpl/option.sgml b/docs/reference/glib/tmpl/option.sgml
index 2e28a50df..15a9ac69c 100644
--- a/docs/reference/glib/tmpl/option.sgml
+++ b/docs/reference/glib/tmpl/option.sgml
@@ -162,7 +162,7 @@ options.
 @error: A return location for errors. The error code %G_OPTION_ERROR_FAILED
   is intended to be used for errors in #GOptionArgFunc callbacks.
 @Returns: %TRUE if the option was successfully parsed, %FALSE if an error 
-  occurred
+  occurred, in which case @error should be set with g_set_error()
 
 
 <!-- ##### STRUCT GOptionContext ##### -->
@@ -441,7 +441,7 @@ the application can then add to its #GOptionContext.
 
 <!-- ##### USER_FUNCTION GOptionParseFunc ##### -->
 <para>
-The type of function that can be called before and after parsing.
+The type of function that can be called before and after parsing. 
 </para>
 
 @context: The active #GOptionContext
@@ -450,7 +450,7 @@ The type of function that can be called before and after parsing.
   was created with g_option_group_new()
 @error: A return location for error details
 @Returns: %TRUE if the function completed successfully, %FALSE if an error 
-  occurred
+  occurred, in which case @error should be set with g_set_error()
 
 
 <!-- ##### FUNCTION g_option_group_set_parse_hooks ##### -->
@@ -465,8 +465,7 @@ The type of function that can be called before and after parsing.
 
 <!-- ##### USER_FUNCTION GOptionErrorFunc ##### -->
 <para>
-The type of function to be used as callback when a parse error
-occurs.
+The type of function to be used as callback when a parse error occurs.
 </para>
 
 @context: The active #GOptionContext