diff mbox series

[RFC,1/6] Tell the glossary about core.hooksPath

Message ID 1589681624-36969-2-git-send-email-keni@hers.com (mailing list archive)
State New, archived
Headers show
Series various documentation bits | expand

Commit Message

Kenneth Lorber May 17, 2020, 2:13 a.m. UTC
From: Kenneth Lorber <keni@his.com>

The user manual glossary entry for hooks now knows about core.hooksPath.

Signed-off-by: Kenneth Lorber <keni@his.com>
---
 Documentation/glossary-content.txt | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

Comments

Junio C Hamano May 17, 2020, 6:33 p.m. UTC | #1
Kenneth Lorber <keni@hers.com> writes:

> From: Kenneth Lorber <keni@his.com>
>
> The user manual glossary entry for hooks now knows about core.hooksPath.
>
> Signed-off-by: Kenneth Lorber <keni@his.com>
> ---
>  Documentation/glossary-content.txt | 10 ++++++----
>  1 file changed, 6 insertions(+), 4 deletions(-)

That's a gap worth filling.

> diff --git a/Documentation/glossary-content.txt b/Documentation/glossary-content.txt
> index 090c888335..37147db1bc 100644
> --- a/Documentation/glossary-content.txt
> +++ b/Documentation/glossary-content.txt
> @@ -206,10 +206,12 @@ for a more flexible and robust system to do the same thing.
>  	to optional scripts that allow a developer to add functionality or
>  	checking. Typically, the hooks allow for a command to be pre-verified
>  	and potentially aborted, and allow for a post-notification after the
> -	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/`
> +	or in any directory specified by the `core.hooksPath` configuration

I expect "the", instead of "any", would make more sense to readers.

It is true that you can choose any directory of your liking and
specify it via the variable, but once chosen that would be the only
directory used for the purpose.

> +	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

Thanks.
Kenneth Lorber May 18, 2020, 10:06 p.m. UTC | #2
> On May 17, 2020, at 2:33 PM, Junio C Hamano <gitster@pobox.com> wrote:
> 
> Kenneth Lorber <keni@hers.com> writes:
> 
>> From: Kenneth Lorber <keni@his.com>
>> 
>> The user manual glossary entry for hooks now knows about core.hooksPath.
>> 
>> Signed-off-by: Kenneth Lorber <keni@his.com>
>> ---
>> Documentation/glossary-content.txt | 10 ++++++----
>> 1 file changed, 6 insertions(+), 4 deletions(-)
> 
> That's a gap worth filling.

Thanks.

> 
>> diff --git a/Documentation/glossary-content.txt b/Documentation/glossary-content.txt
>> index 090c888335..37147db1bc 100644
>> --- a/Documentation/glossary-content.txt
>> +++ b/Documentation/glossary-content.txt
>> @@ -206,10 +206,12 @@ for a more flexible and robust system to do the same thing.
>> 	to optional scripts that allow a developer to add functionality or
>> 	checking. Typically, the hooks allow for a command to be pre-verified
>> 	and potentially aborted, and allow for a post-notification after the
>> -	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/`
>> +	or in any directory specified by the `core.hooksPath` configuration
> 
> I expect "the", instead of "any", would make more sense to readers.

I agree, but I copied it from user-manual.txt, search for core.excludesFile.
Should it be changed there as well?

> 
> It is true that you can choose any directory of your liking and
> specify it via the variable, but once chosen that would be the only
> directory used for the purpose.
> 
>> +	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
> 
> Thanks.

You're welcome.
diff mbox series

Patch

diff --git a/Documentation/glossary-content.txt b/Documentation/glossary-content.txt
index 090c888335..37147db1bc 100644
--- a/Documentation/glossary-content.txt
+++ b/Documentation/glossary-content.txt
@@ -206,10 +206,12 @@  for a more flexible and robust system to do the same thing.
 	to optional scripts that allow a developer to add functionality or
 	checking. Typically, the hooks allow for a command to be pre-verified
 	and potentially aborted, and allow for a post-notification after the
-	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/`
+	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