Fifteenth batch for 2.14
[git/git.git] / templates / hooks--prepare-commit-msg.sample
CommitLineData
8089c85b
PB
1#!/bin/sh
2#
3# An example hook script to prepare the commit log message.
100e762a 4# Called by "git commit" with the name of the file that has the
8089c85b
PB
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#
f98f8cba 10# To enable this hook, rename this file to "prepare-commit-msg".
8089c85b
PB
11
12# This hook includes three examples. The first comments out the
13# "Conflicts:" part of a merge commit.
14#
15# The second includes the output of "git diff --name-status -r"
16# into the message, just before the "git status" output. It is
17# commented because it doesn't cope with --amend or with squashed
18# commits.
19#
20# The third example adds a Signed-off-by line to the message, that can
21# still be edited. This is rarely a good idea.
22
4be1fe1b
MK
23case "$2,$3" in
24 merge,)
502be959 25 @PERL_PATH@ -i.bak -ne 's/^/# /, s/^# #/#/ if /^Conflicts/ .. /#/; print' "$1" ;;
8089c85b 26
4be1fe1b 27# ,|template,)
502be959 28# @PERL_PATH@ -i.bak -pe '
8089c85b
PB
29# print "\n" . `git diff --cached --name-status -r`
30# if /^#/ && $first++ == 0' "$1" ;;
31
32 *) ;;
33esac
34
35# SOB=$(git var GIT_AUTHOR_IDENT | sed -n 's/^\(.*>\).*$/Signed-off-by: \1/p')
36# grep -qs "^$SOB" "$1" || echo "$SOB" >> "$1"