docs: explain inconsistency of _{read,write}_all()
authorRyan Lortie <desrt@desrt.ca>
Mon, 29 Sep 2014 15:50:05 +0000 (11:50 -0400)
committerRyan Lortie <desrt@desrt.ca>
Tue, 21 Oct 2014 16:09:57 +0000 (12:09 -0400)
commit223b5f757fe07cdec2879315965297a31edc3478
tree2c767665a9886f12eeb2cca8a969fcd88992ec20
parentc8d10470939847069b1a346d4c44f2adde3469f6
docs: explain inconsistency of _{read,write}_all()

These functions are inconsistent with our normal conventions in that
they set an output variable to a specified value, even in the case that
an error is thrown.

Document very clearly that this should be considered exceptional.

https://bugzilla.gnome.org/show_bug.cgi?id=737451
gio/ginputstream.c
gio/goutputstream.c