From 91ae46c37b2f7c576a558a19f58173e96974dff5 Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Tue, 2 Nov 2004 05:11:10 +0000 Subject: [PATCH] Document that this function may not return. 2004-11-02 Matthias Clasen * glib/goption.c (g_option_context_parse): Document that this function may not return. --- ChangeLog | 5 +++++ ChangeLog.pre-2-10 | 5 +++++ ChangeLog.pre-2-12 | 5 +++++ ChangeLog.pre-2-6 | 5 +++++ ChangeLog.pre-2-8 | 5 +++++ glib/goption.c | 6 ++++++ 6 files changed, 31 insertions(+) diff --git a/ChangeLog b/ChangeLog index 84654c2..272167b 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,8 @@ +2004-11-02 Matthias Clasen + + * glib/goption.c (g_option_context_parse): Document that + this function may not return. + 2004-11-01 Matthias Clasen * glib/gutils.h: Make gtkdoc-scan happy by removing spaces diff --git a/ChangeLog.pre-2-10 b/ChangeLog.pre-2-10 index 84654c2..272167b 100644 --- a/ChangeLog.pre-2-10 +++ b/ChangeLog.pre-2-10 @@ -1,3 +1,8 @@ +2004-11-02 Matthias Clasen + + * glib/goption.c (g_option_context_parse): Document that + this function may not return. + 2004-11-01 Matthias Clasen * glib/gutils.h: Make gtkdoc-scan happy by removing spaces diff --git a/ChangeLog.pre-2-12 b/ChangeLog.pre-2-12 index 84654c2..272167b 100644 --- a/ChangeLog.pre-2-12 +++ b/ChangeLog.pre-2-12 @@ -1,3 +1,8 @@ +2004-11-02 Matthias Clasen + + * glib/goption.c (g_option_context_parse): Document that + this function may not return. + 2004-11-01 Matthias Clasen * glib/gutils.h: Make gtkdoc-scan happy by removing spaces diff --git a/ChangeLog.pre-2-6 b/ChangeLog.pre-2-6 index 84654c2..272167b 100644 --- a/ChangeLog.pre-2-6 +++ b/ChangeLog.pre-2-6 @@ -1,3 +1,8 @@ +2004-11-02 Matthias Clasen + + * glib/goption.c (g_option_context_parse): Document that + this function may not return. + 2004-11-01 Matthias Clasen * glib/gutils.h: Make gtkdoc-scan happy by removing spaces diff --git a/ChangeLog.pre-2-8 b/ChangeLog.pre-2-8 index 84654c2..272167b 100644 --- a/ChangeLog.pre-2-8 +++ b/ChangeLog.pre-2-8 @@ -1,3 +1,8 @@ +2004-11-02 Matthias Clasen + + * glib/goption.c (g_option_context_parse): Document that + this function may not return. + 2004-11-01 Matthias Clasen * glib/gutils.h: Make gtkdoc-scan happy by removing spaces diff --git a/glib/goption.c b/glib/goption.c index 960a097..35a4e3d 100644 --- a/glib/goption.c +++ b/glib/goption.c @@ -1056,6 +1056,12 @@ free_pending_nulls (GOptionContext *context, * removed from the array and @argc and @argv are updated * accordingly. In case of an error, @argc and @argv are * left unmodified. + * + * If automatic support is enabled + * (see g_option_context_set_help_enabled()), and the + * @argv array contains one of the recognized help options, + * this function will produce help output to stdout and + * call exit (0). * * Return value: %TRUE if the parsing was successful, * %FALSE if an error occurred -- 2.7.4