Skip to content

Commit

Permalink
run-command: factor out child_process_clear()
Browse files Browse the repository at this point in the history
Avoid duplication by moving the code to release allocated memory for
arguments and environment to its own function, child_process_clear().
Export it to provide a counterpart to child_process_init().

Signed-off-by: Rene Scharfe <l.s.r@web.de>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
  • Loading branch information
René Scharfe authored and Junio C Hamano committed Nov 2, 2015
1 parent a2558fb commit 2d71608
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 6 deletions.
7 changes: 7 additions & 0 deletions Documentation/technical/api-run-command.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
15 changes: 9 additions & 6 deletions run-command.c
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,12 @@ void child_process_init(struct child_process *child)
argv_array_init(&child->env_array);
}

void child_process_clear(struct child_process *child)
{
argv_array_clear(&child->args);
argv_array_clear(&child->env_array);
}

struct child_to_clean {
pid_t pid;
struct child_to_clean *next;
Expand Down Expand Up @@ -336,8 +342,7 @@ int start_command(struct child_process *cmd)
fail_pipe:
error("cannot create %s pipe for %s: %s",
str, cmd->argv[0], strerror(failed_errno));
argv_array_clear(&cmd->args);
argv_array_clear(&cmd->env_array);
child_process_clear(cmd);
errno = failed_errno;
return -1;
}
Expand Down Expand Up @@ -523,8 +528,7 @@ int start_command(struct child_process *cmd)
close_pair(fderr);
else if (cmd->err)
close(cmd->err);
argv_array_clear(&cmd->args);
argv_array_clear(&cmd->env_array);
child_process_clear(cmd);
errno = failed_errno;
return -1;
}
Expand All @@ -550,8 +554,7 @@ int start_command(struct child_process *cmd)
int finish_command(struct child_process *cmd)
{
int ret = wait_or_whine(cmd->pid, cmd->argv[0]);
argv_array_clear(&cmd->args);
argv_array_clear(&cmd->env_array);
child_process_clear(cmd);
return ret;
}

Expand Down
1 change: 1 addition & 0 deletions run-command.h
Original file line number Diff line number Diff line change
Expand Up @@ -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 *);
Expand Down

0 comments on commit 2d71608

Please sign in to comment.