[Pkg-gnupg-commit] [libassuan] 285/437: Add comments.

[Eric Dorland]

This is an automated email from the git hooks/post-receive script.

eric pushed a commit to branch master
in repository libassuan.

commit 9fb2db180d67d69dde8ab423489f3be17b8c9bc1
Author: Marcus Brinkmann <mb at g10code.com>
Date:   Tue Jan 5 04:07:48 2010 +0000

    Add comments.
---
 src/assuan-buffer.c | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

diff --git a/src/assuan-buffer.c b/src/assuan-buffer.c
index 8dac4fb..1fd394b 100644
--- a/src/assuan-buffer.c
+++ b/src/assuan-buffer.c
@@ -31,7 +31,11 @@
 
 
 /* Extended version of write(2) to guarantee that all bytes are
-   written.  Returns 0 on success or -1 and ERRNO on failure. */
+   written.  Returns 0 on success or -1 and ERRNO on failure.  NOTE:
+   This function does not return the number of bytes written, so any
+   error must be treated as fatal for this connection as the state of
+   the receiver is unknown.  This works best if blocking is allowed
+   (so EAGAIN cannot occur).  */
 static int
 writen (assuan_context_t ctx, const char *buffer, size_t length)
 {
@@ -93,7 +97,8 @@ readline (assuan_context_t ctx, char *buf, size_t buflen,
 }
 
 
-/* Function returns an Assuan error.  */
+/* Read a line with buffering of partial lines.  Function returns an
+   Assuan error.  */
 gpg_error_t
 _assuan_read_line (assuan_context_t ctx)
 {

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-gnupg/libassuan.git