From: Arun Raghavan <arun.raghavan@collabora.co.uk>
Date: Fri, 14 Jun 2013 11:42:03 +0000 (+0530)
Subject: iochannel: Document modified pa_iochannel_write return value
X-Git-Tag: accepted/tizen/20131022.162753~264
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=4e05333a93550dcc13ac58947397abd25db4eafd;p=platform%2Fupstream%2Fpulseaudio.git

iochannel: Document modified pa_iochannel_write return value
---

diff --git a/src/pulsecore/iochannel.h b/src/pulsecore/iochannel.h
index f809f47..ee3cd67 100644
--- a/src/pulsecore/iochannel.h
+++ b/src/pulsecore/iochannel.h
@@ -48,6 +48,8 @@ channel specify -1 for the other direction. */
 pa_iochannel* pa_iochannel_new(pa_mainloop_api*m, int ifd, int ofd);
 void pa_iochannel_free(pa_iochannel*io);
 
+/* Returns: length written on success, 0 if a retry is needed, negative value
+ * on error. */
 ssize_t pa_iochannel_write(pa_iochannel*io, const void*data, size_t l);
 ssize_t pa_iochannel_read(pa_iochannel*io, void*data, size_t l);