[PATCH v2 2/3] run-command: export child_process_clear()
- From
René Scharfe <l.s.r@web.de>
- Date
- Oct 31, 2015, 09:20 UTC
- Message-ID
- <563487C6.4050504@web.de>
- In-Reply-To
- <56348709.9080207@web.de>
Make the API symmetric by including a cleanup function as a counterpart to child_process_init().
Signed-off-by: Rene Scharfe <l.s.r@web.de> --- Documentation/technical/api-run-command.txt | 7 +++++++ run-command.c | 2 +- run-command.h | 1 + 3 files changed, 9 insertions(+), 1 deletion(-)
diff --git a/Documentation/technical/api-run-command.txt b/Documentation/technical/api-run-command.txt index a9fdb45..8bf3e37 100644 --- a/Documentation/technical/api-run-command.txt +++ b/Documentation/technical/api-run-command.txt @@ -46,6 +46,13 @@ Functions The argument dir corresponds the member .dir. The argument env corresponds to the member .env. +`child_process_clear`:: + + Release the memory associated with the struct child_process. + Most users of the run-command API don't need to call this + function explicitly because `start_command` invokes it on + failure and `finish_command` calls it automatically already. + The functions above do the following: . If a system call failed, errno is set and -1 is returned. A diagnostic diff --git a/run-command.c b/run-command.c index b10ec75..0a3c24e 100644 --- a/run-command.c +++ b/run-command.c @@ -13,7 +13,7 @@ void child_process_init(struct child_process *child) argv_array_init(&child->env_array); } -static void child_process_clear(struct child_process *child) +void child_process_clear(struct child_process *child) { argv_array_clear(&child->args); argv_array_clear(&child->env_array); diff --git a/run-command.h b/run-command.h index 9fe37ee..e296bd2 100644 --- a/run-command.h +++ b/run-command.h @@ -47,6 +47,7 @@ struct child_process { #define CHILD_PROCESS_INIT { NULL, ARGV_ARRAY_INIT, ARGV_ARRAY_INIT } void child_process_init(struct child_process *); +void child_process_clear(struct child_process *); int start_command(struct child_process *); int finish_command(struct child_process *);
-- 2.6.2