Re: [PATCH 8/8] replace and remove run_command_v_opt()

From: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Date: Oct 27, 2022, 22:41 UTC
Message-ID: <221028.86mt9gants.gmgdl@evledraar.gmail.com>
In-Reply-To: <72e04965-56ec-73cb-4554-9e3bc8f10cb5@web.de>

On Thu, Oct 27 2022, René Scharfe wrote:

Show 16 quoted lines

>  #ifndef NO_PTHREADS
>  static pthread_t main_thread;
>  static int main_thread_set;
> diff --git a/run-command.h b/run-command.h
> index 04bd07dc7a..fe2717ad11 100644
> --- a/run-command.h
> +++ b/run-command.h
> @@ -151,7 +151,7 @@ struct child_process {
>
>  /**
>   * The functions: child_process_init, start_command, finish_command,
> - * run_command, run_command_v_opt, child_process_clear do the following:
> + * run_command, child_process_clear do the following:
>   *
>   * - If a system call failed, errno is set and -1 is returned. A diagnostic
>   *   is printed.

A pre-existing issue mostly, but maybe worth cleaning up while we're fixing these docs in general.

This summary is incorrect, because the first bullet point is claiming that these "return -1", but 2 functions on this list return void.

It looks to me if we just remove child_process_{init,clear} altgother from this it'll be correct. They have their own docs below, and this is really describing how this now-simpler API works vis-a-vis the start/run/finish functions.