aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/githooks.txt
diff options
context:
space:
mode:
authorKaartic Sivaraam <kaarticsivaraam91196@gmail.com>2017-07-11 20:00:54 +0530
committerJunio C Hamano <gitster@pobox.com>2017-07-12 13:21:07 -0700
commit0ef1a4e32a720928a497a13ef08aa8f0a63dc476 (patch)
treeffca643827a7d8163812c804dca663f08255a845 /Documentation/githooks.txt
parente1a4a28373befdce97daf9702f6ab790c9806451 (diff)
downloadgit-0ef1a4e32a720928a497a13ef08aa8f0a63dc476.tar.gz
hook: add a simple first example
Add a simple example that replaces an outdated example that was removed. This ensures that there's at the least a simple example that illustrates what could be done using the hook just by enabling it. Also, update the documentation. Signed-off-by: Kaartic Sivaraam <kaarticsivaraam91196@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/githooks.txt')
-rw-r--r--Documentation/githooks.txt3
1 files changed, 3 insertions, 0 deletions
diff --git a/Documentation/githooks.txt b/Documentation/githooks.txt
index 43f3555075..623ed1a138 100644
--- a/Documentation/githooks.txt
+++ b/Documentation/githooks.txt
@@ -121,6 +121,9 @@ it is not suppressed by the `--no-verify` option. A non-zero exit
means a failure of the hook and aborts the commit. It should not
be used as replacement for pre-commit hook.
+The sample `prepare-commit-msg` hook that comes with Git removes the
+help message found in the commented portion of the commit template.
+
commit-msg
~~~~~~~~~~