@matheusbsbs / matheus-bagliano / commits / 8cbbdc92f7

doc: join default pre-commit paragraphs

Join two paragraphs that start with the standard “The default <hook>, when enabled” into one and put it at the end of the “pre-commit” section. The trailing whitespace paragraph was added in the first commit for the doc, in 6d35cc76 (Document hooks., 2005-09-02). Then 3e14dd2c (mention use of "hooks.allownonascii" in "man githooks", 2019-02-20) updated the “pre-commit” section to mention the non-ASCII check that was added in d00e364d.[1] But this paragraph was added one-past the original “default” paragraph, after the env. variable paragraph, and starts exactly the same. That causes the flow of this section to feel off (paragraphs in order): 1. Invoked by <cmd> and what parameters it takes 2. The default 'pre-commit' hook catches introduction of trailing whitespace 3. `GIT_EDITOR=:` 4. The default pre-commit' hook catches introduction of non-ASCII filenames Let’s instead join these two paragrahs and explain the whole behavior of the default script. † 1: Extend sample pre-commit hook to check for non ascii filenames, 2009-05-19 Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Kristoffer Haugsbakk committed Dec 8, 2025 at 08:27 UTC 8cbbdc92f77a20014d9c425c8b9e4af46e492204
1 file changed +4 -7
Documentation/githooks.adoc
+4 -7
@@ -103,17 +103,14 @@ invoked before obtaining the proposed commit log message and
103 making a commit. Exiting with a non-zero status from this script
104 causes the `git commit` command to abort before creating a commit.
105
106 -The default 'pre-commit' hook, when enabled, catches introduction
107 -of lines with trailing whitespaces and aborts the commit when
108 -such a line is found.
109 -
106 All the `git commit` hooks are invoked with the environment
107 variable `GIT_EDITOR=:` if the command will not bring up an editor
108 to modify the commit message.
109
114 -The default 'pre-commit' hook, when enabled--and with the
115 -`hooks.allownonascii` config option unset or set to false--prevents
116 -the use of non-ASCII filenames.
110 +The default 'pre-commit' hook, when enabled, prevents the introduction
111 +of non-ASCII filenames and lines with trailing whitespace. The non-ASCII
112 +check can be turned off by setting the `hooks.allownonascii` config
113 +option to `true`.
114
115 pre-merge-commit
116 ~~~~~~~~~~~~~~~~