[libvirt] [PATCH 1/7] Add documentation for __virExec and virExec

[Daniel P. Berrange]

On Tue, Apr 28, 2009 at 11:31:51AM -0400, Cole Robinson wrote:
> ---
>  src/util.c |   27 +++++++++++++++++++++++++++
>  1 files changed, 27 insertions(+), 0 deletions(-)
> 
> diff --git a/src/util.c b/src/util.c
> index b7e0362..87e215d 100644
> --- a/src/util.c
> +++ b/src/util.c
> @@ -266,6 +266,26 @@ int virSetCloseExec(int fd) {
>      return 0;
>  }
>  
> +/*
> + * @conn Connection to report errors against
> + * @argv argv to exec
> + * @envp optional enviroment to use for exec
> + * @keepfd options fd_ret to keep open for child process
> + * @retpid optional pointer to store child process pid
> + * @infd optional file descriptor to use as child input, otherwise /dev/null
> + * @outfd optional pointer to communicate output fd behavior
> + *        outfd == NULL : Use /dev/null
> + *        *outfd == -1  : Use a new fd
> + *        *outfd != -1  : Use *outfd
> + * @errfd optional pointer to communcate error fd behavior. See outfd
> + * @flags possible combination of the following:
> + *        VIR_EXEC_NONE     : Default function behavior
> + *        VIR_EXEC_NONBLOCK : Set child process output fd's as non-blocking
> + *        VIR_EXEC_DAEMON   : Daemonize the child process (don't use directly,
> + *                            use virExecDaemonize wrapper)
> + * @hook optional virExecHook function to call prior to exec
> + * @data data to pass to the hook function
> + */
>  static int
>  __virExec(virConnectPtr conn,
>            const char *const*argv,
> @@ -550,6 +570,13 @@ virExecWithHook(virConnectPtr conn,
>                       flags, hook, data);
>  }
>  
> +/*
> + * See __virExec for explanation of the arguments.
> + *
> + * Wrapper function for __virExec, with a simpler set of parameters.
> + * Used to insulate the numerous callers from changes to __virExec argument
> + * list.
> + */
>  int
>  virExec(virConnectPtr conn,
>          const char *const*argv,
> -- 


ACK

Daniel
-- 
|: Red Hat, Engineering, London   -o-   http://people.redhat.com/berrange/ :|
|: http://libvirt.org  -o-  http://virt-manager.org  -o-  http://ovirt.org :|
|: http://autobuild.org       -o-         http://search.cpan.org/~danberr/ :|
|: GnuPG: 7D3B9505  -o-  F3C9 553F A1DA 4AC2 5648 23C1 B3DF F742 7D3B 9505 :|