Add some documentation to __virExec and virExec

This commit is contained in:
Cole Robinson 2009-05-04 15:41:46 +00:00
parent aaabde58cb
commit a4d0a3fd50
2 changed files with 31 additions and 0 deletions

View File

@ -1,3 +1,7 @@
Mon May 4 11:40:27 EDT 2009 Cole Robinson <crobinso@redhat.com>
* src/util.c: Add some documentation to __virExec and virExec
Tue Apr 28 11:54:22 BST 2009 Daniel P. Berrange <berrange@redhat.com>
Fix check for -Wformat-security which depends on -Wformat

View File

@ -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,