After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 673174 - g_input_stream_read[_finish]: document returning 0 on EOF
g_input_stream_read[_finish]: document returning 0 on EOF
Status: RESOLVED FIXED
Product: glib
Classification: Platform
Component: docs
unspecified
Other All
: Normal normal
: ---
Assigned To: gtkdev
gtkdev
Depends on:
Blocks:
 
 
Reported: 2012-03-30 13:44 UTC by Will Thompson
Modified: 2012-04-02 17:11 UTC
See Also:
GNOME target: ---
GNOME version: ---

Attachments
g_input_stream_read[_finish]: document returning 0 on EOF (1.43 KB, patch)
2012-03-30 13:44 UTC, Will Thompson 		committed Details | Review

Description Will Thompson 2012-03-30 13:44:18 UTC 
I missed the references to these functions returning 0 on EOF on my first few readings of their documentation; this patch makes it a little clearer.
Comment 1 Will Thompson 2012-03-30 13:44:20 UTC 
Created attachment 210955 [details] [review]
g_input_stream_read[_finish]: document returning 0 on EOF

g_input_stream_read() does state that it returns 0 on end of file, but
not in the Returns: line, so it's easy to miss on a quick skim-read.

g_input_stream_read_async() documents that g_input_stream_read_finish()
returns 0 on end of file, but g_input_stream_read_finish() itself does
not.
Comment 2 Dan Winship 2012-03-30 13:53:45 UTC 
Comment on attachment 210955 [details] [review]
g_input_stream_read[_finish]: document returning 0 on EOF

sure
Comment 3 Will Thompson 2012-04-02 17:11:15 UTC 
Attachment 210955 [details] pushed as f2c77ee - g_input_stream_read[_finish]: document returning 0 on EOF