2 # Copyright 2013, Alexis La Goutte (See AUTHORS file)
4 # For git user: copy tools/pre-commit to .git/hooks/ folder and make it
5 # executable. To bypass it for a single commit, use the --no-verify argument.
6 # Using --no-verify will then fail during git review because of a missing
7 # ChangeID. Fix that by running git review -i. Do not use -i during normal
10 # Alternatively, invoke it directly with the commit ID. Example for checking the
13 # tools/pre-commit HEAD~
15 # Relative paths are also supported. For instance, if you are in epan/, then you
16 # could invoke `../tools/pre-commit HEAD` to check for changes to staged files.
19 # http://mark-story.com/posts/view/using-git-commit-hooks-to-prevent-stupid-mistakes
22 # If the commit identifier is not given, use HEAD instead.
23 COMMIT_ID="${1:-HEAD}"
36 PYBIN=${WS_GITHOOK_PYTHON:-$pyvar}
38 # Path to hook script in the .git directory
39 hook_script=${GIT_DIR:-.git}/hooks/pre-commit
41 # Always start in the root directory of the source tree, this allows for
42 # invocations via relative paths (such as ../tools/pre-commit):
43 if ! cd "$(git rev-parse --show-toplevel)" ; then
44 echo "Can't change to the top-level source directory."
48 # Check for newer (actually, different) versions of the pre-commit script
49 # (but only if invoked as hook, i.e. the commit ID is not given as argument).
50 if [ -z "$1" ] && [ -f "$hook_script" ]; then
51 if ! cmp -s "$hook_script" tools/pre-commit; then
52 echo "Pre-commit hook script is outdated, please update! (cp tools/pre-commit ${hook_script})"
58 COMMIT_FILES=$( git diff-index --cached --name-status "${COMMIT_ID}" | grep -v "^D" | cut -f2 | grep "\\.[ch]$" )
59 DIAMETER_FILES=$( git diff-index --cached --name-status "${COMMIT_ID}" | grep -v "^D" | cut -f2 | grep diameter/ )
61 # Path to filter script in the tools directory
62 filter_script=${PWD}/tools/pre-commit-ignore.py
63 filter_conf=${PWD}/tools/pre-commit-ignore.conf
65 if [ -f "$filter_script" ] && [ -f "$filter_conf" ]; then
66 CHECK_FILES=$( echo "$COMMIT_FILES" | "$PYBIN" "$filter_script" "$filter_conf" ) || exit
68 CHECK_FILES="$COMMIT_FILES"
71 # On windows python will output \r\n line endings - we don't want that.
73 # Do not use sed, as not all versions of sed support \r as meaning CR
74 # in a regexp - the only version that does so might be GNU sed; the
75 # GNU sed documentation says that only \n and \\ can be used in a
78 # The Single UNIX Specification says that tr supports \r; most if not
79 # all modern UN*Xes should support it.
80 CHECK_FILES=$( echo "$CHECK_FILES" | tr -d '\r' )
82 for FILE in $CHECK_FILES; do
84 #Check if checkhf is good
85 ./tools/checkhf.pl "$FILE" || exit_status=1
87 #Check if checkAPIs is good
88 ./tools/checkAPIs.pl -p "$FILE" || exit_status=1
90 #Check if fix-encoding-args is good
91 ./tools/fix-encoding-args.pl "$FILE" || exit_status=1
93 #Check if checkfiltername is good
94 ./tools/checkfiltername.pl "$FILE" || exit_status=1
96 # If there are whitespace errors, print the offending file names and fail. (from git pre-commit.sample)
97 git diff-index --check --cached "${COMMIT_ID}" "$FILE" || exit_status=1
101 if [ "x$DIAMETER_FILES" != x ]
103 ./tools/validate-diameter-xml.sh > /dev/null || exit_status=1
114 # indent-tabs-mode: nil
117 # ex: set shiftwidth=4 tabstop=8 expandtab:
118 # :indentSize=4:tabSize=8:noTabs=true: