Re: [PATCH] sub-process: fix comment about api-sub-process.txt

From: Jonathan Nieder <jrnieder@gmail.com>
Date: Jun 14, 2017, 18:26 UTC
Message-ID: <20170614182607.GW133952@aiede.mtv.corp.google.com>
In-Reply-To: <20170614151225.31055-1-chriscool@tuxfamily.org>

Christian Couder wrote:

> Subject: sub-process: fix comment about api-sub-process.txt

nit: this one-line description doesn't describe what was wrong and is being fixed. I think something like

	sub-process: correct path to API docs in comment

would be easier to understand in "git log" output.

> Signed-off-by: Christian Couder <chriscool@tuxfamily.org>
> ---
>  sub-process.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)

With or without such a tweak,
Reviewed-by: Jonathan Nieder <jrnieder@gmail.com>

Show 13 quoted lines

> diff --git a/sub-process.h b/sub-process.h
> index 7d451e1cde..d9a45cd359 100644
> --- a/sub-process.h
> +++ b/sub-process.h
> @@ -7,7 +7,7 @@
>  
>  /*
>   * Generic implementation of background process infrastructure.
> - * See Documentation/technical/api-background-process.txt.
> + * See: Documentation/technical/api-sub-process.txt
>   */
>  
>   /* data structures */