Merge branch 'jc/mention-tracking-for-pull-default'
[git.git] / git-sh-setup.sh
1 #!/bin/sh
2 #
3 # This is included in commands that either have to be run from the toplevel
4 # of the repository, or with GIT_DIR environment variable properly.
5 # If the GIT_DIR does not look like the right correct git-repository,
6 # it dies.
7
8 # Having this variable in your environment would break scripts because
9 # you would cause "cd" to be taken to unexpected places.  If you
10 # like CDPATH, define it for your interactive shell sessions without
11 # exporting it.
12 # But we protect ourselves from such a user mistake nevertheless.
13 unset CDPATH
14
15 # Similarly for IFS, but some shells (e.g. FreeBSD 7.2) are buggy and
16 # do not equate an unset IFS with IFS with the default, so here is
17 # an explicit SP HT LF.
18 IFS='   
19 '
20
21 git_broken_path_fix () {
22         case ":$PATH:" in
23         *:$1:*) : ok ;;
24         *)
25                 PATH=$(
26                         SANE_TOOL_PATH="$1"
27                         IFS=: path= sep=
28                         set x $PATH
29                         shift
30                         for elem
31                         do
32                                 case "$SANE_TOOL_PATH:$elem" in
33                                 (?*:/bin | ?*:/usr/bin)
34                                         path="$path$sep$SANE_TOOL_PATH"
35                                         sep=:
36                                         SANE_TOOL_PATH=
37                                 esac
38                                 path="$path$sep$elem"
39                                 sep=:
40                         done
41                         echo "$path"
42                 )
43                 ;;
44         esac
45 }
46
47 # @@BROKEN_PATH_FIX@@
48
49 die () {
50         die_with_status 1 "$@"
51 }
52
53 die_with_status () {
54         status=$1
55         shift
56         echo >&2 "$*"
57         exit "$status"
58 }
59
60 GIT_QUIET=
61
62 say () {
63         if test -z "$GIT_QUIET"
64         then
65                 printf '%s\n' "$*"
66         fi
67 }
68
69 if test -n "$OPTIONS_SPEC"; then
70         usage() {
71                 "$0" -h
72                 exit 1
73         }
74
75         parseopt_extra=
76         [ -n "$OPTIONS_KEEPDASHDASH" ] &&
77                 parseopt_extra="--keep-dashdash"
78
79         eval "$(
80                 echo "$OPTIONS_SPEC" |
81                         git rev-parse --parseopt $parseopt_extra -- "$@" ||
82                 echo exit $?
83         )"
84 else
85         dashless=$(basename "$0" | sed -e 's/-/ /')
86         usage() {
87                 die "Usage: $dashless $USAGE"
88         }
89
90         if [ -z "$LONG_USAGE" ]
91         then
92                 LONG_USAGE="Usage: $dashless $USAGE"
93         else
94                 LONG_USAGE="Usage: $dashless $USAGE
95
96 $LONG_USAGE"
97         fi
98
99         case "$1" in
100                 -h)
101                 echo "$LONG_USAGE"
102                 exit
103         esac
104 fi
105
106 set_reflog_action() {
107         if [ -z "${GIT_REFLOG_ACTION:+set}" ]
108         then
109                 GIT_REFLOG_ACTION="$*"
110                 export GIT_REFLOG_ACTION
111         fi
112 }
113
114 git_editor() {
115         if test -z "${GIT_EDITOR:+set}"
116         then
117                 GIT_EDITOR="$(git var GIT_EDITOR)" || return $?
118         fi
119
120         eval "$GIT_EDITOR" '"$@"'
121 }
122
123 git_pager() {
124         if test -t 1
125         then
126                 GIT_PAGER=$(git var GIT_PAGER)
127         else
128                 GIT_PAGER=cat
129         fi
130         : ${LESS=-FRSX}
131         export LESS
132
133         eval "$GIT_PAGER" '"$@"'
134 }
135
136 sane_grep () {
137         GREP_OPTIONS= LC_ALL=C grep "$@"
138 }
139
140 sane_egrep () {
141         GREP_OPTIONS= LC_ALL=C egrep "$@"
142 }
143
144 is_bare_repository () {
145         git rev-parse --is-bare-repository
146 }
147
148 cd_to_toplevel () {
149         cdup=$(git rev-parse --show-toplevel) &&
150         cd "$cdup" || {
151                 echo >&2 "Cannot chdir to $cdup, the toplevel of the working tree"
152                 exit 1
153         }
154 }
155
156 require_work_tree_exists () {
157         if test "z$(git rev-parse --is-bare-repository)" != zfalse
158         then
159                 die "fatal: $0 cannot be used without a working tree."
160         fi
161 }
162
163 require_work_tree () {
164         test "$(git rev-parse --is-inside-work-tree 2>/dev/null)" = true ||
165         die "fatal: $0 cannot be used without a working tree."
166 }
167
168 require_clean_work_tree () {
169         git rev-parse --verify HEAD >/dev/null || exit 1
170         git update-index -q --ignore-submodules --refresh
171         err=0
172
173         if ! git diff-files --quiet --ignore-submodules
174         then
175                 echo >&2 "Cannot $1: You have unstaged changes."
176                 err=1
177         fi
178
179         if ! git diff-index --cached --quiet --ignore-submodules HEAD --
180         then
181                 if [ $err = 0 ]
182                 then
183                     echo >&2 "Cannot $1: Your index contains uncommitted changes."
184                 else
185                     echo >&2 "Additionally, your index contains uncommitted changes."
186                 fi
187                 err=1
188         fi
189
190         if [ $err = 1 ]
191         then
192                 test -n "$2" && echo >&2 "$2"
193                 exit 1
194         fi
195 }
196
197 # Generate a sed script to parse identities from a commit.
198 #
199 # Reads the commit from stdin, which should be in raw format (e.g., from
200 # cat-file or "--pretty=raw").
201 #
202 # The first argument specifies the ident line to parse (e.g., "author"), and
203 # the second specifies the environment variable to put it in (e.g., "AUTHOR"
204 # for "GIT_AUTHOR_*"). Multiple pairs can be given to parse author and
205 # committer.
206 pick_ident_script () {
207         while test $# -gt 0
208         do
209                 lid=$1; shift
210                 uid=$1; shift
211                 printf '%s' "
212                 /^$lid /{
213                         s/'/'\\\\''/g
214                         h
215                         s/^$lid "'\([^<]*\) <[^>]*> .*$/\1/'"
216                         s/.*/GIT_${uid}_NAME='&'/p
217
218                         g
219                         s/^$lid "'[^<]* <\([^>]*\)> .*$/\1/'"
220                         s/.*/GIT_${uid}_EMAIL='&'/p
221
222                         g
223                         s/^$lid "'[^<]* <[^>]*> \(.*\)$/@\1/'"
224                         s/.*/GIT_${uid}_DATE='&'/p
225                 }
226                 "
227         done
228         echo '/^$/q'
229 }
230
231 # Create a pick-script as above and feed it to sed. Stdout is suitable for
232 # feeding to eval.
233 parse_ident_from_commit () {
234         LANG=C LC_ALL=C sed -ne "$(pick_ident_script "$@")"
235 }
236
237 # Parse the author from a commit given as an argument. Stdout is suitable for
238 # feeding to eval to set the usual GIT_* ident variables.
239 get_author_ident_from_commit () {
240         encoding=$(git config i18n.commitencoding || echo UTF-8)
241         git show -s --pretty=raw --encoding="$encoding" "$1" -- |
242         parse_ident_from_commit author AUTHOR
243 }
244
245 # Clear repo-local GIT_* environment variables. Useful when switching to
246 # another repository (e.g. when entering a submodule). See also the env
247 # list in git_connect()
248 clear_local_git_env() {
249         unset $(git rev-parse --local-env-vars)
250 }
251
252
253 # Platform specific tweaks to work around some commands
254 case $(uname -s) in
255 *MINGW*)
256         # Windows has its own (incompatible) sort and find
257         sort () {
258                 /usr/bin/sort "$@"
259         }
260         find () {
261                 /usr/bin/find "$@"
262         }
263         # git sees Windows-style pwd
264         pwd () {
265                 builtin pwd -W
266         }
267         is_absolute_path () {
268                 case "$1" in
269                 [/\\]* | [A-Za-z]:*)
270                         return 0 ;;
271                 esac
272                 return 1
273         }
274         ;;
275 *)
276         is_absolute_path () {
277                 case "$1" in
278                 /*)
279                         return 0 ;;
280                 esac
281                 return 1
282         }
283 esac
284
285 # Make sure we are in a valid repository of a vintage we understand,
286 # if we require to be in a git repository.
287 if test -z "$NONGIT_OK"
288 then
289         GIT_DIR=$(git rev-parse --git-dir) || exit
290         if [ -z "$SUBDIRECTORY_OK" ]
291         then
292                 test -z "$(git rev-parse --show-cdup)" || {
293                         exit=$?
294                         echo >&2 "You need to run this command from the toplevel of the working tree."
295                         exit $exit
296                 }
297         fi
298         test -n "$GIT_DIR" && GIT_DIR=$(cd "$GIT_DIR" && pwd) || {
299                 echo >&2 "Unable to determine absolute path of git directory"
300                 exit 1
301         }
302         : ${GIT_OBJECT_DIRECTORY="$GIT_DIR/objects"}
303 fi