mirrors/git
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

githooks.txt: minor improvements to the grammar & phrasing

Browse Source 
Change:

 * Sentences that needed "the" or "a" to either add those or change them
   so they don't need them.

 * The little tangent about "You can use this to do X (if your project
   wants to do X)" can just be shortened to "if you want to do X".

 * s/parameter/parameters/ when the plural made more sense.

Most of this goes all the way back to the initial introduction of
hooks.txt in 6d35cc76 (Document hooks., 2005-09-02).

Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Ævar Arnfjörð Bjarmason
2016-05-04 22:58:11 +00:00
committed by Junio C Hamano
parent bf7d977f8c
commit de0824ed8f
1 changed files with 16 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
Documentation/githooks.txt
View File

@ -39,15 +39,15 @@ HOOKS
applypatch-msg applypatch-msg
~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~
This hook is invoked by 'git am' script. It takes a single This hook is invoked by 'git am'. It takes a single
parameter, the name of the file that holds the proposed commit parameter, the name of the file that holds the proposed commit
log message. Exiting with non-zero status causes log message. Exiting with a non-zero status causes 'git am' to abort
'git am' to abort before applying the patch. before applying the patch.
The hook is allowed to edit the message file in place, and can The hook is allowed to edit the message file in place, and can
be used to normalize the message into some project standard be used to normalize the message into some project standard
format (if the project has one). It can also be used to refuse format. It can also be used to refuse the commit after inspecting
the commit after inspecting the message file. the message file.
The default 'applypatch-msg' hook, when enabled, runs the The default 'applypatch-msg' hook, when enabled, runs the
'commit-msg' hook, if the latter is enabled. 'commit-msg' hook, if the latter is enabled.
@ -80,10 +80,10 @@ pre-commit
~~~~~~~~~~ ~~~~~~~~~~
This hook is invoked by 'git commit', and can be bypassed This hook is invoked by 'git commit', and can be bypassed
with `--no-verify` option. It takes no parameter, and is with the `--no-verify` option. It takes no parameters, and is
invoked before obtaining the proposed commit log message and invoked before obtaining the proposed commit log message and
making a commit. Exiting with non-zero status from this script making a commit. Exiting with a non-zero status from this script
causes the 'git commit' to abort. causes the 'git commit' command to abort before creating a commit.
The default 'pre-commit' hook, when enabled, catches introduction The default 'pre-commit' hook, when enabled, catches introduction
of lines with trailing whitespaces and aborts the commit when of lines with trailing whitespaces and aborts the commit when
@ -122,15 +122,15 @@ commit-msg
~~~~~~~~~~ ~~~~~~~~~~
This hook is invoked by 'git commit', and can be bypassed This hook is invoked by 'git commit', and can be bypassed
with `--no-verify` option. It takes a single parameter, the with the `--no-verify` option. It takes a single parameter, the
name of the file that holds the proposed commit log message. name of the file that holds the proposed commit log message.
Exiting with non-zero status causes the 'git commit' to Exiting with a non-zero status causes the 'git commit' to
abort. abort.
The hook is allowed to edit the message file in place, and can The hook is allowed to edit the message file in place, and can be used
be used to normalize the message into some project standard to normalize the message into some project standard format. It
format (if the project has one). It can also be used to refuse can also be used to refuse the commit after inspecting the message
the commit after inspecting the message file. file.
The default 'commit-msg' hook, when enabled, detects duplicate The default 'commit-msg' hook, when enabled, detects duplicate
"Signed-off-by" lines, and aborts the commit if one is found. "Signed-off-by" lines, and aborts the commit if one is found.
@ -138,8 +138,8 @@ The default 'commit-msg' hook, when enabled, detects duplicate
post-commit post-commit
~~~~~~~~~~~ ~~~~~~~~~~~
This hook is invoked by 'git commit'. It takes no This hook is invoked by 'git commit'. It takes no parameters, and is
parameter, and is invoked after a commit is made. invoked after a commit is made.
This hook is meant primarily for notification, and cannot affect This hook is meant primarily for notification, and cannot affect
the outcome of 'git commit'. the outcome of 'git commit'.