Kaartic Sivaraam <kaarticsivaraam91...@gmail.com> writes:
> 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 remove the relevant comments from the sample script
> and update the documentation.
>
> Signed-off-by: Kaartic Sivaraam <kaarticsivaraam91...@gmail.com>
> ---
> Documentation/githooks.txt | 3 ---
> templates/hooks--prepare-commit-msg.sample | 20 ++++++++------------
> 2 files changed, 8 insertions(+), 15 deletions(-)
>
> diff --git a/Documentation/githooks.txt b/Documentation/githooks.txt
> index 706091a56..fdc01aa25 100644
> --- a/Documentation/githooks.txt
> +++ b/Documentation/githooks.txt
> @@ -121,9 +121,6 @@ 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 comments
> -out the `Conflicts:` part of a merge's commit message.
> -
> commit-msg
> ~~~~~~~~~~
Makes sense.
>
> diff --git a/templates/hooks--prepare-commit-msg.sample
> b/templates/hooks--prepare-commit-msg.sample
> index 86b8f227e..b8ba335cf 100755
> --- a/templates/hooks--prepare-commit-msg.sample
> +++ b/templates/hooks--prepare-commit-msg.sample
> @@ -9,8 +9,7 @@
> #
> # To enable this hook, rename this file to "prepare-commit-msg".
>
> -# This hook includes three examples. The first comments out the
> -# "Conflicts:" part of a merge commit.
> +# This hook includes three examples.
Didn't we just remove one, reducing the total number to two? If so,
the second and the third below would need to be promoted to the
first and the second, I think.
> # The second includes the output of "git diff --name-status -r"
> # into the message, just before the "git status" output. It is
> @@ -20,17 +19,14 @@
> # The third 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
> - merge,)
> - @PERL_PATH@ -i.bak -ne 's/^/# /, s/^# #/#/ if /^Conflicts/ .. /#/;
> print' "$1" ;;
>
> -# ,|template,)
> -# @PERL_PATH@ -i.bak -pe '
> -# print "\n" . `git diff --cached --name-status -r`
> -# if /^#/ && $first++ == 0' "$1" ;;
> -
> - *) ;;
> -esac
> +# 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"
