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

[Ben Peart <peartben@gmail.com>]

On 6/14/2017 2:26 PM, Jonathan Nieder wrote:
> 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

Looks good to me.  Thanks for finding/fixing this.

> 
> 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>
> 
>> 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 */