Clarify that only one of the conditions listed in the docs need to be

Thu Jul 25 19:12:43 2002  Owen Taylor  <otaylor@redhat.com>

        * glib/giochannel.c (g_io_channel_set_encoding): Clarify
        that only one of the conditions listed in the docs
        need to be true, not all of them. (#87176,
        Sebastian Rittau)

        * glib/giochannel.c (g_io_channel_read_line): Fix
        description of the return value. (#87754, Manuel Clos)

diff --git a/ChangeLog b/ChangeLog
index 38a7dbf..1a61b88 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,13 @@
+Thu Jul 25 19:12:43 2002  Owen Taylor  <otaylor@redhat.com>
+
+       * glib/giochannel.c (g_io_channel_set_encoding): Clarify
+       that only one of the conditions listed in the docs
+       need to be true, not all of them. (#87176,
+       Sebastian Rittau)
+
+       * glib/giochannel.c (g_io_channel_read_line): Fix 
+       description of the return value. (#87754, Manuel Clos)
+
 Thu Jul 25 19:02:53 2002  Owen Taylor  <otaylor@redhat.com>
 
        * glib/gmain.c (g_timeout_add): Remove reference

diff --git a/ChangeLog.pre-2-10 b/ChangeLog.pre-2-10
index 38a7dbf..1a61b88 100644 (file)
--- a/ChangeLog.pre-2-10
+++ b/ChangeLog.pre-2-10
@@ -1,3 +1,13 @@
+Thu Jul 25 19:12:43 2002  Owen Taylor  <otaylor@redhat.com>
+
+       * glib/giochannel.c (g_io_channel_set_encoding): Clarify
+       that only one of the conditions listed in the docs
+       need to be true, not all of them. (#87176,
+       Sebastian Rittau)
+
+       * glib/giochannel.c (g_io_channel_read_line): Fix 
+       description of the return value. (#87754, Manuel Clos)
+
 Thu Jul 25 19:02:53 2002  Owen Taylor  <otaylor@redhat.com>
 
        * glib/gmain.c (g_timeout_add): Remove reference

diff --git a/ChangeLog.pre-2-12 b/ChangeLog.pre-2-12
index 38a7dbf..1a61b88 100644 (file)
--- a/ChangeLog.pre-2-12
+++ b/ChangeLog.pre-2-12
@@ -1,3 +1,13 @@
+Thu Jul 25 19:12:43 2002  Owen Taylor  <otaylor@redhat.com>
+
+       * glib/giochannel.c (g_io_channel_set_encoding): Clarify
+       that only one of the conditions listed in the docs
+       need to be true, not all of them. (#87176,
+       Sebastian Rittau)
+
+       * glib/giochannel.c (g_io_channel_read_line): Fix 
+       description of the return value. (#87754, Manuel Clos)
+
 Thu Jul 25 19:02:53 2002  Owen Taylor  <otaylor@redhat.com>
 
        * glib/gmain.c (g_timeout_add): Remove reference

diff --git a/ChangeLog.pre-2-2 b/ChangeLog.pre-2-2
index 38a7dbf..1a61b88 100644 (file)
--- a/ChangeLog.pre-2-2
+++ b/ChangeLog.pre-2-2
@@ -1,3 +1,13 @@
+Thu Jul 25 19:12:43 2002  Owen Taylor  <otaylor@redhat.com>
+
+       * glib/giochannel.c (g_io_channel_set_encoding): Clarify
+       that only one of the conditions listed in the docs
+       need to be true, not all of them. (#87176,
+       Sebastian Rittau)
+
+       * glib/giochannel.c (g_io_channel_read_line): Fix 
+       description of the return value. (#87754, Manuel Clos)
+
 Thu Jul 25 19:02:53 2002  Owen Taylor  <otaylor@redhat.com>
 
        * glib/gmain.c (g_timeout_add): Remove reference

diff --git a/ChangeLog.pre-2-4 b/ChangeLog.pre-2-4
index 38a7dbf..1a61b88 100644 (file)
--- a/ChangeLog.pre-2-4
+++ b/ChangeLog.pre-2-4
@@ -1,3 +1,13 @@
+Thu Jul 25 19:12:43 2002  Owen Taylor  <otaylor@redhat.com>
+
+       * glib/giochannel.c (g_io_channel_set_encoding): Clarify
+       that only one of the conditions listed in the docs
+       need to be true, not all of them. (#87176,
+       Sebastian Rittau)
+
+       * glib/giochannel.c (g_io_channel_read_line): Fix 
+       description of the return value. (#87754, Manuel Clos)
+
 Thu Jul 25 19:02:53 2002  Owen Taylor  <otaylor@redhat.com>
 
        * glib/gmain.c (g_timeout_add): Remove reference

diff --git a/ChangeLog.pre-2-6 b/ChangeLog.pre-2-6
index 38a7dbf..1a61b88 100644 (file)
--- a/ChangeLog.pre-2-6
+++ b/ChangeLog.pre-2-6
@@ -1,3 +1,13 @@
+Thu Jul 25 19:12:43 2002  Owen Taylor  <otaylor@redhat.com>
+
+       * glib/giochannel.c (g_io_channel_set_encoding): Clarify
+       that only one of the conditions listed in the docs
+       need to be true, not all of them. (#87176,
+       Sebastian Rittau)
+
+       * glib/giochannel.c (g_io_channel_read_line): Fix 
+       description of the return value. (#87754, Manuel Clos)
+
 Thu Jul 25 19:02:53 2002  Owen Taylor  <otaylor@redhat.com>
 
        * glib/gmain.c (g_timeout_add): Remove reference

diff --git a/ChangeLog.pre-2-8 b/ChangeLog.pre-2-8
index 38a7dbf..1a61b88 100644 (file)
--- a/ChangeLog.pre-2-8
+++ b/ChangeLog.pre-2-8
@@ -1,3 +1,13 @@
+Thu Jul 25 19:12:43 2002  Owen Taylor  <otaylor@redhat.com>
+
+       * glib/giochannel.c (g_io_channel_set_encoding): Clarify
+       that only one of the conditions listed in the docs
+       need to be true, not all of them. (#87176,
+       Sebastian Rittau)
+
+       * glib/giochannel.c (g_io_channel_read_line): Fix 
+       description of the return value. (#87754, Manuel Clos)
+
 Thu Jul 25 19:02:53 2002  Owen Taylor  <otaylor@redhat.com>
 
        * glib/gmain.c (g_timeout_add): Remove reference

diff --git a/glib/giochannel.c b/glib/giochannel.c
index c5e8978..254342a 100644 (file)
--- a/glib/giochannel.c
+++ b/glib/giochannel.c
@@ -1007,7 +1007,8 @@ g_io_channel_get_buffered (GIOChannel *channel)
  *
  * The encoding %NULL is safe to use with binary data.
  *
- * The encoding can only be set under the following conditions:
+ * The encoding can only be set if one of the following conditions
+ * is true:
  *
  * 1. The channel was just created, and has not been written to
  *    or read from yet.
@@ -1030,9 +1031,9 @@ g_io_channel_get_buffered (GIOChannel *channel)
  *    g_io_channel_read_line_string (), or g_io_channel_read_to_end ()
  *    does <emphasis>not</emphasis> guarantee that the encoding can be changed.
  *
- * Channels which do not meet the above conditions cannot call
+ * Channels which do not meet one of the above conditions cannot call
  * g_io_channel_seek_position () with an offset of %G_SEEK_CUR,
- * and if they are "seekable" cannot
+ * and, if they are "seekable", cannot
  * call g_io_channel_write_chars () after calling one
  * of the API "read" functions.
  *
@@ -1367,11 +1368,10 @@ reencode:
  *
  * Reads a line, including the terminating character(s),
  * from a #GIOChannel into a newly-allocated string.
- * @length will contain allocated memory if the return
+ * @str_return will contain allocated memory if the return
  * is %G_IO_STATUS_NORMAL.
  *
- * Return value: a newly-allocated string. Free this string
- *   with g_free() when you are done with it.
+ * Return value: the status of the operation.
  **/
 GIOStatus
 g_io_channel_read_line (GIOChannel *channel,