[Pkg-gnupg-commit] [libassuan] 327/437: doc changes

[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 c942aefbeff7379dc2cd2f730a333b4909217912
Author: Werner Koch <wk at gnupg.org>
Date:   Wed Aug 11 14:01:10 2010 +0000

    doc changes
---
 doc/assuan.texi | 5 ++++-
 src/client.c    | 9 ++++-----
 src/context.c   | 4 ++--
 3 files changed, 10 insertions(+), 8 deletions(-)

diff --git a/doc/assuan.texi b/doc/assuan.texi
index f7a5e56..1121935 100644
--- a/doc/assuan.texi
+++ b/doc/assuan.texi
@@ -822,9 +822,12 @@ process to die in @code{assuan_release}.  In certain cases this is
 not desirable.  By setting this flag, a call to @code{waitpid} will be
 suppressed and the caller is responsible to cleanup the child process.
 @item ASSUAN_CONFIDENTIAL
-Uses to return the state of the confidential logging mode.
+Use to return the state of the confidential logging mode.
 @item ASSUAN_NO_FIXSIGNALS
 Do not modify signal handler for @code{SIGPIPE}.
+ at item ASSUAN_CONVEY_COMMENTS
+If enabled comment lines are passed to the status callback of the
+ at code{assuan_transact}.
 @end table
 @end deftp
 @end deftypefun
diff --git a/src/client.c b/src/client.c
index 3dfcf75..64efffd 100644
--- a/src/client.c
+++ b/src/client.c
@@ -228,11 +228,10 @@ _assuan_read_from_server (assuan_context_t ctx, assuan_response_t *response,
  * 
  * FIXME: Write documentation
  * 
- * Return value: 0 on success or error code.  The error code may be
- * the one one returned by the server in error lines or from the
- * callback functions.  Take care: When a callback returns an error
- * this function returns immediately with an error and thus the caller
- * will altter return an Assuan error (write erro in most cases).
+ * Return value: 0 on success or an error code.  The error code may be
+ * the one one returned by the server via error lines or from the
+ * callback functions.  Take care:  If a callback returns an error
+ * this function returns immediately with this error.
  **/
 gpg_error_t
 assuan_transact (assuan_context_t ctx,
diff --git a/src/context.c b/src/context.c
index c55f626..6b30236 100644
--- a/src/context.c
+++ b/src/context.c
@@ -122,7 +122,7 @@ assuan_get_flag (assuan_context_t ctx, assuan_flag_t flag)
 }
 
 
-/* Same as assuan_set_flag (ctx, ASSUAN_NO_WAITPID, 1).  */
+/* Same as assuan_set_flag (ctx, ASSUAN_CONFIDENTIAL, 1).  */
 void
 assuan_begin_confidential (assuan_context_t ctx)
 {
@@ -130,7 +130,7 @@ assuan_begin_confidential (assuan_context_t ctx)
 }
 
 
-/* Same as assuan_set_flag (ctx, ASSUAN_NO_WAITPID, 0).  */
+/* Same as assuan_set_flag (ctx, ASSUAN_CONFIDENTIAL, 0).  */
 void
 assuan_end_confidential (assuan_context_t ctx)
 {

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