# [PATCH] sub-process: fix comment about api-sub-process.txt 4 messages from 2017-06-14 to 2017-06-15. Participants: Christian Couder, Jonathan Nieder, Ben Peart, Junio C Hamano. Thread: https://gitlist.dev/t/46183 ## Christian Couder, 2017-06-14 15:12 Subject: [PATCH] sub-process: fix comment about api-sub-process.txt Message-ID: <20170614151225.31055-1-chriscool@tuxfamily.org> URL: https://gitlist.dev/e/20170614151225.31055-1-chriscool%40tuxfamily.org ``` Signed-off-by: Christian Couder --- sub-process.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 */ -- 2.13.1.453.g04e95ab038 ``` ## Jonathan Nieder, 2017-06-14 18:26 Subject: Re: [PATCH] sub-process: fix comment about api-sub-process.txt Message-ID: <20170614182607.GW133952@aiede.mtv.corp.google.com> URL: https://gitlist.dev/e/20170614182607.GW133952%40aiede.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 > --- > sub-process.h | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) With or without such a tweak, Reviewed-by: Jonathan Nieder > 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 */ ``` ## Ben Peart, 2017-06-15 14:10 Subject: Re: [PATCH] sub-process: fix comment about api-sub-process.txt Message-ID: <62acd48f-8442-e9bf-9e96-ce9fa2228dac@gmail.com> URL: https://gitlist.dev/e/62acd48f-8442-e9bf-9e96-ce9fa2228dac%40gmail.com In-Reply-To: <20170614182607.GW133952@aiede.mtv.corp.google.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 >> --- >> sub-process.h | 2 +- >> 1 file changed, 1 insertion(+), 1 deletion(-) > > With or without such a tweak, > Reviewed-by: Jonathan Nieder > >> 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 */ ``` ## Junio C Hamano, 2017-06-15 21:34 Subject: Re: [PATCH] sub-process: fix comment about api-sub-process.txt Message-ID: URL: https://gitlist.dev/e/xmqqmv99ylys.fsf%40gitster.mtv.corp.google.com In-Reply-To: <20170614182607.GW133952@aiede.mtv.corp.google.com> ``` Jonathan Nieder writes: > 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. Indeed. Thanks. > >> Signed-off-by: Christian Couder >> --- >> sub-process.h | 2 +- >> 1 file changed, 1 insertion(+), 1 deletion(-) > > With or without such a tweak, > Reviewed-by: Jonathan Nieder > >> 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 */ ```