mirror of
https://github.com/git/git.git
synced 2026-02-27 18:29:43 +00:00
83804c361b
If the body of a commit message contains a diff that is not indented then "git am" will treat that diff as part of the patch rather than as part of the commit message. This allows it to apply email messages that were created by adding a commit message in front of a regular diff without adding the "---" separator used by "git format-patch". This often surprises users [1-4] so add a check to the sample "commit-msg" hook to reject messages that would confuse "git am". Even if a project does not use an email based workflow it is not uncommon for people to generate patches from it and apply them with "git am". Therefore it is still worth discouraging the creation of commit messages that would not be applied correctly. A further source of confusion when applying patches with "git am" is the "---" separator that is added by "git format patch". If a commit message body contains that line then it will be truncated by "git am". As this is often used by patch authors to add some commentary that they do not want to end up in the commit message when the patch is applied, the hook does not complain about the presence of "---" lines in the message. Detecting if the message contains a diff is complicated by the hook being passed the message before it is cleaned up so we need to ignore any diffs below the scissors line. There are also two possible config keys to check to find the comment character at the start of the scissors line. The first paragraph of the commit message becomes the email subject header which beings "Subject: " and so does not need to be checked. The trailing ".*" when matching commented lines ensures that if the comment string ends with a "$" it is not treated as an anchor. [1] https://lore.kernel.org/git/bcqvh7ahjjgzpgxwnr4kh3hfkksfruf54refyry3ha7qk7dldf@fij5calmscvm [2] https://lore.kernel.org/git/ca13705ae4817ffba16f97530637411b59c9eb19.camel@scientia.org/ [3] https://lore.kernel.org/git/d0b577825124ac684ab304d3a1395f3d2d0708e8.1662333027.git.matheus.bernardino@usp.br/ [4] https://lore.kernel.org/git/CAFOYHZC6Qd9wkoWPcTJDxAs9u=FGpHQTkjE-guhwkya0DRVA6g@mail.gmail.com/ Signed-off-by: Phillip Wood <phillip.wood@dunelm.org.uk> Signed-off-by: Junio C Hamano <gitster@pobox.com>
75 lines
1.9 KiB
Bash
Executable File
75 lines
1.9 KiB
Bash
Executable File
#!/bin/sh
|
|
#
|
|
# An example hook script to check the commit log message.
|
|
# Called by "git commit" with one argument, the name of the file
|
|
# that has the commit message. The hook should exit with non-zero
|
|
# status after issuing an appropriate message if it wants to stop the
|
|
# commit. The hook is allowed to edit the commit message file.
|
|
#
|
|
# To enable this hook, rename this file to "commit-msg".
|
|
|
|
# Uncomment the below to add a Signed-off-by line to the message.
|
|
# Doing this in a hook is a bad idea in general, but the prepare-commit-msg
|
|
# hook is more suited to it.
|
|
#
|
|
# SOB=$(git var GIT_AUTHOR_IDENT | sed -n 's/^\(.*>\).*$/Signed-off-by: \1/p')
|
|
# grep -qs "^$SOB" "$1" || echo "$SOB" >> "$1"
|
|
|
|
# This example catches duplicate Signed-off-by lines and messages that
|
|
# would confuse 'git am'.
|
|
|
|
ret=0
|
|
|
|
test "" = "$(grep '^Signed-off-by: ' "$1" |
|
|
sort | uniq -c | sed -e '/^[ ]*1[ ]/d')" || {
|
|
echo >&2 Duplicate Signed-off-by lines.
|
|
ret=1
|
|
}
|
|
|
|
comment_re="$(
|
|
{
|
|
git config --get-regexp "^core\.comment(char|string)\$" ||
|
|
echo '#'
|
|
} | sed -n -e '
|
|
${
|
|
s/^[^ ]* //
|
|
s|[][*./\]|\\&|g
|
|
s/^auto$/[#;@!$%^&|:]/
|
|
p
|
|
}'
|
|
)"
|
|
scissors_line="^${comment_re} -\{8,\} >8 -\{8,\}\$"
|
|
comment_line="^${comment_re}.*"
|
|
blank_line='^[ ]*$'
|
|
# Disallow lines starting with "diff -" or "Index: " in the body of the
|
|
# message. Stop looking if we see a scissors line.
|
|
line="$(sed -n -e "
|
|
# Skip comments and blank lines at the start of the file.
|
|
/${scissors_line}/q
|
|
/${comment_line}/d
|
|
/${blank_line}/d
|
|
# The first paragraph will become the subject header so
|
|
# does not need to be checked.
|
|
: subject
|
|
n
|
|
/${scissors_line}/q
|
|
/${blank_line}/!b subject
|
|
# Check the body of the message for problematic
|
|
# prefixes.
|
|
: body
|
|
n
|
|
/${scissors_line}/q
|
|
/${comment_line}/b body
|
|
/^diff -/{p;q;}
|
|
/^Index: /{p;q;}
|
|
b body
|
|
" "$1")"
|
|
if test -n "$line"
|
|
then
|
|
echo >&2 "Message contains a diff that will confuse 'git am'."
|
|
echo >&2 "To fix this indent the diff."
|
|
ret=1
|
|
fi
|
|
|
|
exit $ret
|