hook: name the positional variables
[git] / templates / hooks--prepare-commit-msg.sample
1 #!/bin/sh
2 #
3 # An example hook script to prepare the commit log message.
4 # Called by "git commit" with the name of the file that has the
5 # commit message, followed by the description of the commit
6 # message's source.  The hook's purpose is to edit the commit
7 # message file.  If the hook fails with a non-zero status,
8 # the commit is aborted.
9 #
10 # To enable this hook, rename this file to "prepare-commit-msg".
11
12 # This hook includes two examples.
13 #
14 # The first includes the output of "git diff --name-status -r"
15 # into the message, just before the "git status" output.  It is
16 # commented because it doesn't cope with --amend or with squashed
17 # commits.
18 #
19 # The second example adds a Signed-off-by line to the message, that can
20 # still be edited.  This is rarely a good idea.
21
22 COMMIT_MSG_FILE=$1
23 COMMIT_SOURCE=$2
24 SHA1=$3
25
26 # case "$COMMIT_SOURCE,$SHA1" in
27 #  ,|template,)
28 #    @PERL_PATH@ -i.bak -pe '
29 #       print "\n" . `git diff --cached --name-status -r`
30 #        if /^#/ && $first++ == 0' "$COMMIT_MSG_FILE" ;;
31 #  *) ;;
32 # esac
33
34 # SOB=$(git var GIT_AUTHOR_IDENT | sed -n 's/^\(.*>\).*$/Signed-off-by: \1/p')
35 # grep -qs "^$SOB" "$COMMIT_MSG_FILE" || echo "$SOB" >> "$COMMIT_MSG_FILE"