[PATCH] clean up assuan documentation

[Neal H. Walfield]

Hi Daniel,

Thanks!  I've applied these changes.

:) Neal


At Thu,  7 May 2015 00:52:48 -0400,
Daniel Kahn Gillmor wrote:
> 
> * doc/assuan.texi: fix documentation
> 
> --
> 
> Reading up on assuan to create python bindings uncovered a few bugs in
> the documentation.
> ---
>  doc/assuan.texi | 18 +++++++++---------
>  1 file changed, 9 insertions(+), 9 deletions(-)
> 
> diff --git a/doc/assuan.texi b/doc/assuan.texi
> index b932be0..b7b8f3f 100644
> --- a/doc/assuan.texi
> +++ b/doc/assuan.texi
> @@ -814,7 +814,7 @@ flags are usually 1 or 0 but certain flags might need other values.
>  
>  @deftp {Data type} assuan_flag_t
>  The flags are all named and collected in an @code{enum} for better readability.
> -Currently only one flag is defined:
> +Available flags are:
>  
>  @table @code
>  @item ASSUAN_NO_WAITPID
> @@ -1072,12 +1072,12 @@ If the peer is not a simple pipe server but one using full-duplex
>  sockets, the full-fledged variant of the above function should be
>  used:
>  
> - at deftypefun gpg_error_t assuan_pipe_connect (@w{assuan_context_t *@var{ctx}}, at w{const char *@var{name}}, @w{const char *@var{argv}[]}, @w{assuan_fd_t *@var{fd_child_list}}, @w{void (*@var{atfork}) (void *, int)}, @w{void *@var{atforkvalue}}, @w{unsigned int @var{flags}})
> + at deftypefun gpg_error_t assuan_pipe_connect (@w{assuan_context_t @var{ctx}}, at w{const char *@var{name}}, @w{const char *@var{argv}[]}, @w{assuan_fd_t *@var{fd_child_list}}, @w{void (*@var{atfork}) (void *, int)}, @w{void *@var{atforkvalue}}, @w{unsigned int @var{flags}})
>  
>  A call to this functions forks the current process and executes the
>  program @var{name}, passing the arguments given in the NULL-terminated
>  list @var{argv}.  A list of file descriptors not to be closed may be
> -given using the @code{ASSUAN_INVLID_FD} terminated array @var{fd_child_list}.
> +given using the @code{ASSUAN_INVALID_FD} terminated array @var{fd_child_list}.
>  
>  If @var{name} is a null pointer, only a fork but no exec is done.  Thus
>  the child continues to run.  However all file descriptors are closed and
> @@ -1115,13 +1115,13 @@ server.  On W32CE systems this flag is ignored.
>  If you are using a long running server listening either on a TCP or a
>  Unix domain socket, the following function is used to connect to the server:
>  
> - at deftypefun gpg_error_t assuan_socket_connect (@w{assuan_context_t *@var{ctx}}, @w{const char *@var{name}}, @w{pid_t @var{server_pid}}, @w{unsigned int @var{flags}})
> + at deftypefun gpg_error_t assuan_socket_connect (@w{assuan_context_t @var{ctx}}, @w{const char *@var{name}}, @w{pid_t @var{server_pid}}, @w{unsigned int @var{flags}})
>  
> -Make a connection to the Unix domain socket @var{name} and return a
> -new Assuan context at @var{ctx}.  @var{server_pid} is currently not
> -used but may become handy in the future; if you don't know the
> -server's process ID (PID), pass @code{ASSUAN_INVALID_PID}.  With
> - at var{flags} set to @code{ASSUAN_SOCKET_CONNECT_FDPASSIN},
> +Make a connection to the Unix domain socket @var{name} using
> +already-initialized Assuan context at @var{ctx}.  @var{server_pid} is
> +currently not used but may become handy in the future; if you don't
> +know the server's process ID (PID), pass @code{ASSUAN_INVALID_PID}.
> +With @var{flags} set to @code{ASSUAN_SOCKET_CONNECT_FDPASSING},
>  @code{sendmsg} and @code{recvmesg} are used for input and output and
>  thereby enable the use of descriptor passing.
>  
> -- 
> 2.1.4
> 
> 
> _______________________________________________
> Gnupg-devel mailing list
> Gnupg-devel at gnupg.org
> http://lists.gnupg.org/mailman/listinfo/gnupg-devel
>