githooks.txt: minor improvements to the grammar & phrasing
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>
Ævar Arnfjörð Bjarmason committed
May 4, 2016 at 22:58 UTC
de0824ed8fa3319cfdc0c79c06c06d7c72c6adc6
1 file changed
+16
-16
Documentation/githooks.txt
+16
-16
@@ -39,15 +39,15 @@ HOOKS
39
applypatch-msg
40
~~~~~~~~~~~~~~
41
42
-This hook is invoked by 'git am' script. It takes a single
42
+This hook is invoked by 'git am'. It takes a single
43
parameter, the name of the file that holds the proposed commit
44
-log message. Exiting with non-zero status causes
45
-'git am' to abort before applying the patch.
44
+log message. Exiting with a non-zero status causes 'git am' to abort
45
+before applying the patch.
46
47
The hook is allowed to edit the message file in place, and can
48
be used to normalize the message into some project standard
49
-format (if the project has one). It can also be used to refuse
50
-the commit after inspecting the message file.
49
+format. It can also be used to refuse the commit after inspecting
50
+the message file.
51
52
The default 'applypatch-msg' hook, when enabled, runs the
53
'commit-msg' hook, if the latter is enabled.
@@ -80,10 +80,10 @@ pre-commit
80
~~~~~~~~~~
81
82
This hook is invoked by 'git commit', and can be bypassed
83
-with `--no-verify` option. It takes no parameter, and is
83
+with the `--no-verify` option. It takes no parameters, and is
84
invoked before obtaining the proposed commit log message and
85
-making a commit. Exiting with non-zero status from this script
86
-causes the 'git commit' to abort.
85
+making a commit. Exiting with a non-zero status from this script
86
+causes the 'git commit' command to abort before creating a commit.
87
88
The default 'pre-commit' hook, when enabled, catches introduction
89
of lines with trailing whitespaces and aborts the commit when
@@ -122,15 +122,15 @@ commit-msg
122
~~~~~~~~~~
123
124
This hook is invoked by 'git commit', and can be bypassed
125
-with `--no-verify` option. It takes a single parameter, the
125
+with the `--no-verify` option. It takes a single parameter, the
126
name of the file that holds the proposed commit log message.
127
-Exiting with non-zero status causes the 'git commit' to
127
+Exiting with a non-zero status causes the 'git commit' to
128
abort.
129
130
-The hook is allowed to edit the message file in place, and can
131
-be used to normalize the message into some project standard
132
-format (if the project has one). It can also be used to refuse
133
-the commit after inspecting the message file.
130
+The hook is allowed to edit the message file in place, and can be used
131
+to normalize the message into some project standard format. It
132
+can also be used to refuse the commit after inspecting the message
133
+file.
134
135
The default 'commit-msg' hook, when enabled, detects duplicate
136
"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
138
post-commit
139
~~~~~~~~~~~
140
141
-This hook is invoked by 'git commit'. It takes no
142
-parameter, and is invoked after a commit is made.
141
+This hook is invoked by 'git commit'. It takes no parameters, and is
142
+invoked after a commit is made.
143
144
This hook is meant primarily for notification, and cannot affect
145
the outcome of 'git commit'.