summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatthias Clasen <mclasen@redhat.com>2004-11-02 05:11:10 +0000
committerMatthias Clasen <matthiasc@src.gnome.org>2004-11-02 05:11:10 +0000
commit91ae46c37b2f7c576a558a19f58173e96974dff5 (patch)
treebf589f68063f31b66af517d0dfca2a8ce5e23437
parentb8f2678c869129ff2b4d50d9e024b11c76854cd4 (diff)
downloadglib-91ae46c37b2f7c576a558a19f58173e96974dff5.tar.gz
Document that this function may not return.
2004-11-02 Matthias Clasen <mclasen@redhat.com> * glib/goption.c (g_option_context_parse): Document that this function may not return.
-rw-r--r--ChangeLog5
-rw-r--r--ChangeLog.pre-2-105
-rw-r--r--ChangeLog.pre-2-125
-rw-r--r--ChangeLog.pre-2-65
-rw-r--r--ChangeLog.pre-2-85
-rw-r--r--glib/goption.c6
6 files changed, 31 insertions, 0 deletions
diff --git a/ChangeLog b/ChangeLog
index 84654c257..272167b90 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2004-11-02 Matthias Clasen <mclasen@redhat.com>
+
+ * glib/goption.c (g_option_context_parse): Document that
+ this function may not return.
+
2004-11-01 Matthias Clasen <mclasen@redhat.com>
* glib/gutils.h: Make gtkdoc-scan happy by removing spaces
diff --git a/ChangeLog.pre-2-10 b/ChangeLog.pre-2-10
index 84654c257..272167b90 100644
--- a/ChangeLog.pre-2-10
+++ b/ChangeLog.pre-2-10
@@ -1,3 +1,8 @@
+2004-11-02 Matthias Clasen <mclasen@redhat.com>
+
+ * glib/goption.c (g_option_context_parse): Document that
+ this function may not return.
+
2004-11-01 Matthias Clasen <mclasen@redhat.com>
* glib/gutils.h: Make gtkdoc-scan happy by removing spaces
diff --git a/ChangeLog.pre-2-12 b/ChangeLog.pre-2-12
index 84654c257..272167b90 100644
--- a/ChangeLog.pre-2-12
+++ b/ChangeLog.pre-2-12
@@ -1,3 +1,8 @@
+2004-11-02 Matthias Clasen <mclasen@redhat.com>
+
+ * glib/goption.c (g_option_context_parse): Document that
+ this function may not return.
+
2004-11-01 Matthias Clasen <mclasen@redhat.com>
* glib/gutils.h: Make gtkdoc-scan happy by removing spaces
diff --git a/ChangeLog.pre-2-6 b/ChangeLog.pre-2-6
index 84654c257..272167b90 100644
--- a/ChangeLog.pre-2-6
+++ b/ChangeLog.pre-2-6
@@ -1,3 +1,8 @@
+2004-11-02 Matthias Clasen <mclasen@redhat.com>
+
+ * glib/goption.c (g_option_context_parse): Document that
+ this function may not return.
+
2004-11-01 Matthias Clasen <mclasen@redhat.com>
* glib/gutils.h: Make gtkdoc-scan happy by removing spaces
diff --git a/ChangeLog.pre-2-8 b/ChangeLog.pre-2-8
index 84654c257..272167b90 100644
--- a/ChangeLog.pre-2-8
+++ b/ChangeLog.pre-2-8
@@ -1,3 +1,8 @@
+2004-11-02 Matthias Clasen <mclasen@redhat.com>
+
+ * glib/goption.c (g_option_context_parse): Document that
+ this function may not return.
+
2004-11-01 Matthias Clasen <mclasen@redhat.com>
* glib/gutils.h: Make gtkdoc-scan happy by removing spaces
diff --git a/glib/goption.c b/glib/goption.c
index 960a09738..35a4e3d07 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 <option>--help</option> 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 <literal>exit (0)</literal>.
*
* Return value: %TRUE if the parsing was successful,
* %FALSE if an error occurred