Add doc note about read_until() inconsistency.

See bug 584284 for more information.

diff --git a/gio/gdatainputstream.c b/gio/gdatainputstream.c
index 2407637..4a380f7 100644 (file)
--- a/gio/gdatainputstream.c
+++ b/gio/gdatainputstream.c
@@ -856,6 +856,9 @@ scan_for_chars (GDataInputStream *stream,
  * Reads a string from the data input stream, up to the first
  * occurrence of any of the stop characters.
  *
+ * Note that, in contrast to g_data_input_stream_read_until_async(),
+ * this function consumes the stop character that it finds.
+ *
  * Returns: a string with the data that was read before encountering
  *     any of the stop characters. Set @length to a #gsize to get the length
  *     of the string. This function will return %NULL on an error.
@@ -1158,6 +1161,10 @@ g_data_input_stream_read_line_async (GDataInputStream    *stream,
  * The asynchronous version of g_data_input_stream_read_until().
  * It is an error to have two outstanding calls to this function.
  *
+ * Note that, in contrast to g_data_input_stream_read_until(),
+ * this function does not consume the stop character that it finds.  You
+ * must read it for yourself.
+ *
  * When the operation is finished, @callback will be called. You
  * can then call g_data_input_stream_read_until_finish() to get
  * the result of the operation.