diff options
| author | René Scharfe <l.s.r@web.de> | 2022-10-30 14:45:13 +0300 |
|---|---|---|
| committer | Taylor Blau <me@ttaylorr.com> | 2022-10-30 21:04:32 +0300 |
| commit | 53c4be3fd82208bde63c6f38556089428c4e5be5 (patch) | |
| tree | 5cfac510ebe1847b05fd0a75b5216fe985de5b85 /run-command.h | |
| parent | 9397f3cf7e4005096e1c03bff52618ddd47b0fe5 (diff) | |
run-command: fix return value comment
483bbd4e4c (run-command: introduce child_process_init(), 2014-08-19) and
2d71608ec0 (run-command: factor out child_process_clear(), 2015-10-24)
added help texts about child_process_init() and child_process_clear()
without updating the immediately following documentation of return codes
that only applied to the preexisting functions.
4c4066d95d (run-command: move doc to run-command.h, 2019-11-17) started
to list the functions explicitly that this paragraph applies to, but
still wrongly included child_process_init() and child_process_clear().
Remove their names from that list.
Suggested-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: René Scharfe <l.s.r@web.de>
Signed-off-by: Taylor Blau <me@ttaylorr.com>
Diffstat (limited to 'run-command.h')
| -rw-r--r-- | run-command.h | 5 |
1 files changed, 2 insertions, 3 deletions
diff --git a/run-command.h b/run-command.h index 0e85e5846a..61073fc589 100644 --- a/run-command.h +++ b/run-command.h @@ -150,9 +150,8 @@ struct child_process { } /** - * The functions: child_process_init, start_command, finish_command, - * run_command, run_command_v_opt, run_command_v_opt_cd_env, child_process_clear - * do the following: + * The functions: start_command, finish_command, run_command, + * run_command_v_opt, run_command_v_opt_cd_env do the following: * * - If a system call failed, errno is set and -1 is returned. A diagnostic * is printed. |