X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=exec.c;h=bbf1b41addf8aab65363065c9e3b6ad91cae4968;hp=0886a0b772f504e6009ae898f03858bb18ad0cf3;hb=ebb0565e946770c5b83c4d28c1f674dffdeaf551;hpb=9f021e58c181e2cd2e1e245fcd7b84f33ad50f9d

diff --git a/exec.c b/exec.c
index 0886a0b7..bbf1b41a 100644
--- a/exec.c
+++ b/exec.c
@@ -1,26 +1,26 @@
 /*
- * Copyright (C) 2003-2006 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2003-2008 Andre Noll <maan@systemlinux.org>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
 
-/** \file exec.c helper functions for spawning new processes */
+/** \file exec.c Helper functions for spawning new processes. */
 #include "para.h"
 #include "close_on_fork.h"
 #include "error.h"
 #include "string.h"
 
 /**
- * spawn a new process and redirect fd 0, 1, and 2
+ * Spawn a new process and redirect fd 0, 1, and 2.
  *
- * \param pid will hold the pid of the created process upon return
- * \param file path of the executable to execute
- * \param args the argument array for the command
- * \param fds a pointer to a value-result array
+ * \param pid Will hold the pid of the created process upon return.
+ * \param file Path of the executable to execute.
+ * \param args The argument array for the command.
+ * \param fds a Pointer to a value-result array.
  *
- * \return Negative on errors, positive on success.
+ * \return Standard.
  *
- * \sa null(4), pipe(2), dup2(2), fork(2), exec(3)
+ * \sa null(4), pipe(2), dup2(2), fork(2), exec(3).
  */
 static int para_exec(pid_t *pid, const char *file, char *const *const args, int *fds)
 {
@@ -106,27 +106,26 @@ err_out:
 	return ret;
 }
 
-
 /**
- * exec the given command
+ * Exec the given command.
  *
- * \param pid will hold the pid of the created process upon return
- * \param cmdline holds the command and its arguments, seperated by spaces
- * \param fds a pointer to a value-result array
+ * \param pid Will hold the pid of the created process upon return.
+ * \param cmdline Holds the command and its arguments, seperated by spaces.
+ * \param fds A pointer to a value-result array.
  *
  * This function uses fork/exec to create a new process. \a fds must be a
  * pointer to three integers, corresponding to stdin, stdout and stderr
  * respectively. It specifies how to deal with fd 0, 1, 2 in the child. The
  * contents of \a fds are interpreted as follows:
  *
- *	- fd[i] < 0: leave fd \a i alone
- *	- fd[i] = 0: dup fd \a i to /dev/null
+ *	- fd[i] < 0: leave fd \a i alone.
+ *	- fd[i] = 0: dup fd \a i to \p /dev/null.
  *	- fd[i] > 0: create a pipe and dup i to one end of that pipe.
  *	Upon return, fd[i] contains the file descriptor of the pipe.
  *
  * 	In any case, all unneeded filedescriptors are closed.
  *
- * \return positive on success, negative on errors
+ * \return Standard.
  */
 int para_exec_cmdline_pid(pid_t *pid, const char *cmdline, int *fds)
 {
@@ -142,4 +141,3 @@ int para_exec_cmdline_pid(pid_t *pid, const char *cmdline, int *fds)
 	free(tmp);
 	return ret;
 }
-