Re: [RFC PATCH v2 1/6] doc: Tell the glossary about core.hooksPath
- From
Kenneth Lorber <keni@his.com>
- Date
- May 27, 2020, 17:18 UTC
- Message-ID
- <79116422-1B77-42E4-BA97-2A0663FF08CB@his.com>
- In-Reply-To
- <79C90EFA-CF65-4AF7-82B2-0B1B6FABA0F8@his.com>
Show 31 quoted lines
> On May 27, 2020, at 12:52 PM, Kenneth Lorber <keni@his.com> wrote: > > > >> On May 26, 2020, at 2:59 PM, Junio C Hamano <gitster@pobox.com> wrote: >> >> Kenneth Lorber <keni@his.com> writes: >> >>> Subject: Re: [RFC PATCH v2 1/6] doc: Tell the glossary about core.hooksPath >> >> Perhaps >> >> Subject: [PATCH] glossary: describe core.hooksPath >> >> Please separate this one patch out and send it again without the >> rest of the series, as this is quite different from the rest of the >> 6-patch series and an obvious clarification, unlike the others. > > Will do. > >> >>> - operation is done. The hook scripts are found in the >>> - `$GIT_DIR/hooks/` directory, and are enabled by simply >>> - removing the `.sample` suffix from the filename. In earlier versions >>> - of Git you had to make them executable. >>> + operation is done. The hook scripts are found in `$GIT_DIR/hooks/` >> >> You accidentally lost 'the', and because you did an unnecessary >> line-wrapping, such a change became harder to spot. > > My apologies.
I just read this section a couple more times and I think the dropped "the" is correct since the sentence structure has changed.
The sentence in question, unwrapped: The hook scripts are found in `$GIT_DIR/hooks/` or in any directory specified by the `core.hooksPath` configuration variable.
It might deserve some additional changes though, since the above vaguely implies both locations are checked, which is incorrect. Perhaps this is more accurate: The hook scripts are found in the directory specified by the `core.hooksPath` configuration variable; the default location is `$GIT_DIR/hooks/`.
Show 22 quoted lines
> >> >> I am not sure if .sample scripts should be a topioc of this glossary >> entry at all to begin with. And I think it outlived the usefulness >> to describe what was in versions of Git that is more than 10 years >> old. I wonder if it is a better idea to take your new description, >> but remove everything after "The sample scripts are enabled..." >> except for the "see ... for details" link? > > I had considered it but didn't want to presume. If I don't hear any objections > I will take it out. > >> >>> + or in any directory specified by the `core.hooksPath` configuration >>> + variable. The sample scripts are enabled by simply >>> + removing the `.sample` suffix from the filename. In earlier versions >>> + of Git you had to make the sample scripts executable manually. >>> + Hook scripts must be executable. See linkgit:githooks[5] for details. >> >>> [[def_index]]index:: >>> A collection of files with stat information, whose contents are stored >