From: Kaartic Sivaraam <kaarticsivaraam91196@gmail.com>
To: gitster@pobox.com
Cc: git@vger.kernel.org
Subject: [PATCH 4/4] hook: add a simple first example
Date: Tue, 11 Jul 2017 20:00:54 +0530 [thread overview]
Message-ID: <20170711143054.9255-1-kaarticsivaraam91196@gmail.com> (raw)
In-Reply-To: <20170711141111.7538-4-kaarticsivaraam91196@gmail.com>
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>
---
Documentation/githooks.txt | 3 +++
templates/hooks--prepare-commit-msg.sample | 9 ++++++---
2 files changed, 9 insertions(+), 3 deletions(-)
diff --git a/Documentation/githooks.txt b/Documentation/githooks.txt
index fdc01aa25..59f38efba 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
~~~~~~~~~~
diff --git a/templates/hooks--prepare-commit-msg.sample b/templates/hooks--prepare-commit-msg.sample
index 87d770592..dc707e46e 100755
--- a/templates/hooks--prepare-commit-msg.sample
+++ b/templates/hooks--prepare-commit-msg.sample
@@ -9,20 +9,23 @@
#
# To enable this hook, rename this file to "prepare-commit-msg".
-# This hook includes two examples.
+# This hook includes three examples. The first one removes the
+# "# Please enter the commit message..." help message.
#
-# The first includes the output of "git diff --name-status -r"
+# The second includes the output of "git diff --name-status -r"
# into the message, just before the "git status" output. It is
# commented because it doesn't cope with --amend or with squashed
# commits.
#
-# The second example adds a Signed-off-by line to the message, that can
+# The third example adds a Signed-off-by line to the message, that can
# still be edited. This is rarely a good idea.
COMMIT_MSG_FILE=$1
COMMIT_SOURCE=$2
SHA1=$3
+@PERL_PATH@ -i.bak -ne 'print unless(m/^. Please enter the commit message/..m/^#$/)' "$COMMIT_MSG_FILE"
+
# case "$COMMIT_SOURCE,$SHA1" in
# ,|template,)
# @PERL_PATH@ -i.bak -pe '
--
2.13.2.957.g457671ade
next prev parent reply other threads:[~2017-07-11 14:31 UTC|newest]
Thread overview: 58+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-06-30 15:43 [PATCH] hooks: add signature to the top of the commit message Kaartic Sivaraam
2017-06-30 16:44 ` Junio C Hamano
2017-07-01 14:15 ` Kaartic Sivaraam
2017-07-01 16:16 ` "git intepret-trailers" vs. "sed script" to add the signature Kaartic Sivaraam
2017-07-01 17:32 ` [PATCH/RFC] hooks: add signature using "interpret-trailers" Kaartic Sivaraam
2017-07-03 16:58 ` "git intepret-trailers" vs. "sed script" to add the signature Junio C Hamano
2017-07-04 19:16 ` Kaartic Sivaraam
2017-07-05 1:48 ` Junio C Hamano
2017-07-05 17:00 ` [PATCH] hooks: add signature using "interpret-trailers" Kaartic Sivaraam
2017-07-05 17:35 ` Kaartic Sivaraam
2017-07-05 19:37 ` Junio C Hamano
2017-07-05 20:14 ` Ramsay Jones
2017-07-06 14:30 ` Kaartic Sivaraam
2017-07-01 17:36 ` [PATCH] hooks: add signature to the top of the commit message Junio C Hamano
2017-07-01 18:40 ` Philip Oakley
2017-07-01 20:28 ` Junio C Hamano
2017-07-01 21:00 ` Philip Oakley
2017-07-01 18:52 ` Kaartic Sivaraam
2017-07-01 20:31 ` Junio C Hamano
2017-07-02 11:19 ` Kaartic Sivaraam
2017-07-02 11:27 ` [PATCH/RFC] hooks: replace irrelevant hook sample Kaartic Sivaraam
2017-07-05 16:51 ` [PATCH] " Kaartic Sivaraam
2017-07-05 19:50 ` Junio C Hamano
2017-07-07 11:53 ` Kaartic Sivaraam
2017-07-07 15:05 ` Junio C Hamano
2017-07-07 15:24 ` Kaartic Sivaraam
2017-07-07 16:07 ` [PATCH 1/2] " Kaartic Sivaraam
2017-07-07 16:07 ` [PATCH 2/2] hooks: add signature using "interpret-trailers" Kaartic Sivaraam
2017-07-07 18:27 ` [PATCH 1/2] hooks: replace irrelevant hook sample Junio C Hamano
2017-07-10 14:17 ` [PATCH 1/4] hook: cleanup script Kaartic Sivaraam
2017-07-10 14:17 ` [PATCH 2/4] hook: name the positional variables Kaartic Sivaraam
2017-07-10 19:51 ` Junio C Hamano
2017-07-10 14:17 ` [PATCH 3/4] hook: add signature using "interpret-trailers" Kaartic Sivaraam
2017-07-10 15:13 ` Ramsay Jones
2017-07-10 19:53 ` Junio C Hamano
2017-07-11 14:11 ` [PATCH 1/4] hook: cleanup script Kaartic Sivaraam
2017-07-11 14:11 ` [PATCH 2/4] hook: name the positional variables Kaartic Sivaraam
2017-07-11 14:11 ` [PATCH 3/4] hook: add sign-off using "interpret-trailers" Kaartic Sivaraam
2017-08-14 8:46 ` [PATCH] hook: use correct logical variable Kaartic Sivaraam
2017-08-14 17:54 ` Stefan Beller
2017-08-14 18:19 ` Junio C Hamano
2017-08-15 9:31 ` Kaartic Sivaraam
2017-08-15 17:28 ` Junio C Hamano
2017-08-17 2:47 ` Kaartic Sivaraam
2017-08-17 2:50 ` [PATCH v2/RFC] " Kaartic Sivaraam
2017-08-15 9:32 ` [PATCH] " Kaartic Sivaraam
2017-07-11 14:11 ` [PATCH 4/4] hook: add a simple first example Kaartic Sivaraam
2017-07-11 14:30 ` Kaartic Sivaraam [this message]
2017-07-11 13:10 ` [PATCH 3/4] hook: add signature using "interpret-trailers" Kaartic Sivaraam
2017-07-11 13:18 ` Kaartic Sivaraam
2017-07-10 14:17 ` [PATCH 4/4] hook: add a simple first example Kaartic Sivaraam
2017-07-10 20:02 ` Junio C Hamano
2017-07-11 13:29 ` Kaartic Sivaraam
2017-07-11 16:03 ` Junio C Hamano
2017-07-11 18:04 ` Kaartic Sivaraam
2017-07-11 18:06 ` Kaartic Sivaraam
2017-07-10 19:50 ` [PATCH 1/4] hook: cleanup script Junio C Hamano
2017-07-02 11:29 ` [PATCH] hooks: add script to HOOKS that allows adding notes from commit message Kaartic Sivaraam
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20170711143054.9255-1-kaarticsivaraam91196@gmail.com \
--to=kaarticsivaraam91196@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).