aboutsummaryrefslogtreecommitdiff
path: root/src/lib/process
diff options
context:
space:
mode:
authorAlexander Færøy <ahf@torproject.org>2018-12-13 00:48:33 +0100
committerNick Mathewson <nickm@torproject.org>2018-12-17 16:39:28 -0500
commita33a77d9cd3c06b5a871e99631b7f1c40bed23c6 (patch)
treed559f5992160d2988c2832e6c82fa24c2615cc8a /src/lib/process
parent0d796cce17bdda605f5e768971935d7f876e33fa (diff)
downloadtor-a33a77d9cd3c06b5a871e99631b7f1c40bed23c6.tar.gz
tor-a33a77d9cd3c06b5a871e99631b7f1c40bed23c6.zip
Document the format of process_t::arguments.
See: https://bugs.torproject.org/28179
Diffstat (limited to 'src/lib/process')
-rw-r--r--src/lib/process/process.c6
1 files changed, 5 insertions, 1 deletions
diff --git a/src/lib/process/process.c b/src/lib/process/process.c
index 75bffe35b9..fb76a0a725 100644
--- a/src/lib/process/process.c
+++ b/src/lib/process/process.c
@@ -55,7 +55,11 @@ struct process_t {
/** Name of the command we want to execute (for example: /bin/ls). */
char *command;
- /** The arguments used for the new process. */
+ /** The arguments used for the new process. The format here is one argument
+ * per element of the smartlist_t. On Windows these arguments are combined
+ * together using the <b>tor_join_win_cmdline</b> function. On Unix the
+ * process name (argv[0]) and the trailing NULL is added automatically before
+ * the process is executed. */
smartlist_t *arguments;
/** The environment used for the new process. */