mirror of
https://github.com/git/git
synced 2024-07-17 02:57:48 +00:00
b22a307946
Prepare the 'preare-commit-msg' sample script for
upcoming changes. Preparation includes removal of
an example that has outlived it's purpose. The example
is the one that comments the "Conflicts:" part of a
merge commit message. It isn't relevant anymore as
it's done by default since 261f315b ("merge & sequencer:
turn "Conflicts:" hint into a comment", 2014-08-28).
Further update the relevant comments from the sample script
and update the documentation.
Signed-off-by: Kaartic Sivaraam <kaarticsivaraam91196@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
33 lines
1.1 KiB
Bash
Executable file
33 lines
1.1 KiB
Bash
Executable file
#!/bin/sh
|
|
#
|
|
# An example hook script to prepare the commit log message.
|
|
# Called by "git commit" with the name of the file that has the
|
|
# commit message, followed by the description of the commit
|
|
# message's source. The hook's purpose is to edit the commit
|
|
# message file. If the hook fails with a non-zero status,
|
|
# the commit is aborted.
|
|
#
|
|
# To enable this hook, rename this file to "prepare-commit-msg".
|
|
|
|
# This hook includes two examples.
|
|
#
|
|
# The first 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
|
|
# still be edited. This is rarely a good idea.
|
|
|
|
|
|
# case "$2,$3" in
|
|
# ,|template,)
|
|
# @PERL_PATH@ -i.bak -pe '
|
|
# print "\n" . `git diff --cached --name-status -r`
|
|
# if /^#/ && $first++ == 0' "$1" ;;
|
|
# *) ;;
|
|
# esac
|
|
|
|
# SOB=$(git var GIT_AUTHOR_IDENT | sed -n 's/^\(.*>\).*$/Signed-off-by: \1/p')
|
|
# grep -qs "^$SOB" "$1" || echo "$SOB" >> "$1"
|