2 # SPDX-License-Identifier: GPL-2.0
5 # This file is part of Lustre, http://www.lustre.org/
7 # contrib/git-hooks/prepare-commit-msg
9 # A Git hook script to prepare the commit log message. Install into
10 # lustre/.git/hooks/prepare-commit-msg to enable for Lustre commits.
12 # Called by git-commit with the name of the file that has the
13 # commit message, followed by the description of the commit
14 # message's source. The hook's purpose is to edit the commit
15 # message file. If the hook fails with a non-zero status,
16 # the commit is aborted.
18 # Commit hook to check the patch against the Lustre coding style.
19 # It adds any checkpatch warnings/errors as commit comments, which
20 # means that they can currently be ignored, but are at least visible.
23 CHECKPATCH=${CHECKPATCH:-contrib/scripts/checkpatch.pl}
24 CHECKPATCH_OPTS=${CHECKPATCH_OPTS:-"--no-signoff --no-tree"}
25 SHELLCHECK=${SHELLCHECK:-$(which shellcheck)}
26 SHELLCHECK_OPTS=${SHELLCHECK_OPTS:-" -f gcc "}
27 SHELLCHECK_RUN=${SHELLCHECK_RUN:-"yes"} # run everytime by default
29 # If there are no comments in the commit, it is likely a rebase and
30 # this shouldn't be adding new comments, or they appear in the commit.
31 grep -q "^#" "$1" || exit 0
33 # Add a commented-out Test-Parameters: line. This will let the developer
34 # uncomment it out if they think it's appropriate.
36 echo "# If this patch makes only non-functional changes, or test-only" >> "$1"
37 echo "# changes, consider adding this 'Test-Parameters' in the" >> "$1"
38 echo "# commit message:" >> "$1"
40 echo "# Test-Parameters: trivial" >> "$1"
42 echo "# If you need to repeat the same subtest many times, consider" >> "$1"
43 echo "# this instead:" >> "$1"
45 echo "# Test-Parameters: trivial testlist=sanity env=ONLY=1,ONLY_REPEAT=100" >> "$1"
47 echo "# https://wiki.whamcloud.com/display/PUB/Changing+Test+Parameters+with+Gerrit+Commit+Messages" >> "$1"
50 # Add a commented-out Signed-off-by: line. This shouldn't be added in an
51 # uncommented form, otherwise sanity checking for an emtpy commit fails.
52 # The developer should uncomment it to include it in the commit message.
54 echo "# The 'Signed-off-by' line signifies that you agree to the Developer" >> "$1"
55 echo "# Certificate of Origin - https://developercertificate.org/" >> "$1"
57 SIGNOFF=$(git var GIT_AUTHOR_IDENT | sed -n 's/^\(.*>\).*$/Signed-off-by: \1/p')
58 grep -qs "^$SIGNOFF" "$1" || echo "# $SIGNOFF" >> "$1"
60 # Add the checkpatch.pl output as comments, but don't cause a commit error
61 # yet, as there may be exceptions and it is better let a person decide.
62 if [ -x "$CHECKPATCH" ]; then
65 [ -d ".git/rebase-apply" -o -d ".git/rebase-merge" ] &&
66 DIFFOPT="HEAD" || DIFFOPT="--cached"
67 git diff $DIFFOPT | $CHECKPATCH $CHECKPATCH_OPTS - |
68 sed -e 's/^/# /' >> "$1"
71 # Add the shellcheck output as comments, but don't cause a commit error.
72 if [[ -x "$SHELLCHECK" && "$SHELLCHECK_RUN" == "yes" ]]; then
75 echo "# shellcheck output:" >> "$1"
77 # Get file that needs to be shellchecked. We only consider *.sh files
79 # modified: lustre/tests/sanity.sh
80 # modified: contrib/git-hooks/prepare-commit-msg
81 # new: lustre/utils/liblustreapi_error.c
83 mod_files=($(awk '/modified:.*\.sh|new:.*\.sh/ { print $3 }' $1))
84 for cur_file in ${mod_files[@]}; do
85 # Shebangs should prefer bash over regular sh. This allows
86 # scripts to freely use bash-isms and lowers the risks of
87 # failures on Debian based platforms. Output a small warning
88 # if #!/bin/sh is found.
89 echo "#" $(grep -Hn "#\!/bin/sh" "$cur_file" && \
90 echo " : Please don't use sh in shebangs.") >> "$1"
92 # Get start/end range of lines that needs to be reported
93 # range presently not used will come in handy when dealing with
94 # warnings reported by shellcheck
95 # Example 'git show' output Start --
96 # @@ -29,6 +29,7 @@ DEF_STRIPE_COUNT=-1
97 # Example 'git show' output End --
98 range=($(git show $cur_file | awk '/^@@/ { print $3 }' | \
99 sed -e 's/+//' -e 's/,/ /'))
100 start_line=${range[0]}
101 end_line=$((start_line + ${range[1]}))
103 # 'shellcheck' reports errors/warnings/notes as below:
105 # sanity-lnet.sh:2319:13: error: Double quote array \
106 # expansions to avoid re-splitting elements. [SC2068]
108 # sanity-lnet.sh:2421:27: note: Double quote to prevent \
109 # globbing and word splitting. [SC2086]
111 # sanity-lnet.sh:2411:8: warning: Declare and assign \
112 # separately to avoid masking return values. [SC2155]
114 $SHELLCHECK $SHELLCHECK_OPTS $cur_file |
115 while IFS=": " read -r file line char mtype msg; do
116 # Only filter out "errors" reported by shellcheck
117 # We ignore "warnings" and "notes" for now.
118 # TODO "Warnings" reported by shellcheck will come later
119 [[ "$mtype" == "error" ]] || continue
120 # Empty line we skip it.
121 [[ -n "$line" ]] || continue
122 echo "# $file:$line:$char $mtype: $msg" >> "$1"
128 # Cause Vim to wrap text at 70 columns to match commit message style.
129 # Adding a matching emacs modeline would be good, if I knew how to do that.
130 echo "# vim:textwidth=70:" >> "$1"
132 # Add these comments at the end
133 # So that Vim does not pretend
134 # The "echo" above is actually
135 # A modeline for this file. Savvy?