From a33a77d9cd3c06b5a871e99631b7f1c40bed23c6 Mon Sep 17 00:00:00 2001 From: Alexander Færøy Date: Thu, 13 Dec 2018 00:48:33 +0100 Subject: Document the format of process_t::arguments. See: https://bugs.torproject.org/28179 --- src/lib/process/process.c | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) (limited to 'src/lib/process') 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 tor_join_win_cmdline 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. */ -- cgit v1.2.3-54-g00ecf