templates: Use heredoc in pre-commit hook
[git/git.git] / templates / hooks--pre-commit.sample
CommitLineData
89e2c5f1
JH
1#!/bin/sh
2#
3# An example hook script to verify what is about to be committed.
100e762a 4# Called by "git commit" with no arguments. The hook should
89e2c5f1
JH
5# exit with non-zero status after issuing an appropriate message if
6# it wants to stop the commit.
7#
f98f8cba 8# To enable this hook, rename this file to "pre-commit".
89e2c5f1 9
100e762a 10if git rev-parse --verify HEAD >/dev/null 2>&1
c30eb852
BS
11then
12 against=HEAD
13else
14 # Initial commit: diff against an empty tree object
15 against=4b825dc642cb6eb9a060e54bf8d69288fbee4904
16fi
17
d00e364d
HV
18# If you want to allow non-ascii filenames set this variable to true.
19allownonascii=$(git config hooks.allownonascii)
20
c14daa48
JM
21# Redirect output to stderr.
22exec 1>&2
23
d00e364d
HV
24# Cross platform projects tend to avoid non-ascii filenames; prevent
25# them from being added to the repository. We exploit the fact that the
26# printable range starts at the space character and ends with tilde.
27if [ "$allownonascii" != "true" ] &&
f1e3156e
JM
28 # Note that the use of brackets around a tr range is ok here, (it's
29 # even required, for portability to Solaris 10's /usr/bin/tr), since
30 # the square bracket bytes happen to fall in the designated range.
c14daa48
JM
31 test $(git diff --cached --name-only --diff-filter=A -z $against |
32 LC_ALL=C tr -d '[ -~]\0' | wc -c) != 0
d00e364d 33then
27b6e17a
RH
34 cat <<\EOF
35Error: Attempt to add a non-ascii file name.
36
37This can cause problems if you want to work
38with people on other platforms.
39
40To be portable it is advisable to rename the file.
41
42If you know what you are doing you can disable this
43check using:
44
45 git config hooks.allownonascii true
46EOF
d00e364d
HV
47 exit 1
48fi
49
c14daa48 50# If there are whitespace errors, print the offending file names and fail.
03e2b630 51exec git diff-index --check --cached $against --