[Spice-devel] [PATCH spice-gtk] spice-channel: Add some comment to spice_channel_read

[Frediano Ziglio]

Document return value.

Signed-off-by: Frediano Ziglio <fziglio at redhat.com>
---
 src/spice-channel.c | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/src/spice-channel.c b/src/spice-channel.c
index 1486137e..602869e1 100644
--- a/src/spice-channel.c
+++ b/src/spice-channel.c
@@ -1124,6 +1124,8 @@ static int spice_channel_read_sasl(SpiceChannel *channel, void *data, size_t len
 
 /*
  * Fill the 'data' buffer up with exactly 'len' bytes worth of data
+ * Returns 0 if connection was closed or unknown errors, <0 for error and
+ * length on success
  */
 /* coroutine context */
 static int spice_channel_read(SpiceChannel *channel, void *data, size_t length)
-- 
2.17.2