Merge branch 'rs/fix-alt-odb-path-comparison' into maint
[git.git] / git-sh-setup.sh
blob5f28b32dc7ff75830bde919b2f4776f7a9b017e2
1 # This shell scriplet is meant to be included by other shell scripts
2 # to set up some variables pointing at the normal git directories and
3 # a few helper shell functions.
5 # Having this variable in your environment would break scripts because
6 # you would cause "cd" to be taken to unexpected places. If you
7 # like CDPATH, define it for your interactive shell sessions without
8 # exporting it.
9 # But we protect ourselves from such a user mistake nevertheless.
10 unset CDPATH
12 # Similarly for IFS, but some shells (e.g. FreeBSD 7.2) are buggy and
13 # do not equate an unset IFS with IFS with the default, so here is
14 # an explicit SP HT LF.
15 IFS='
18 git_broken_path_fix () {
19 case ":$PATH:" in
20 *:$1:*) : ok ;;
22 PATH=$(
23 SANE_TOOL_PATH="$1"
24 IFS=: path= sep=
25 set x $PATH
26 shift
27 for elem
29 case "$SANE_TOOL_PATH:$elem" in
30 (?*:/bin | ?*:/usr/bin)
31 path="$path$sep$SANE_TOOL_PATH"
32 sep=:
33 SANE_TOOL_PATH=
34 esac
35 path="$path$sep$elem"
36 sep=:
37 done
38 echo "$path"
41 esac
44 # @@BROKEN_PATH_FIX@@
46 die () {
47 die_with_status 1 "$@"
50 die_with_status () {
51 status=$1
52 shift
53 printf >&2 '%s\n' "$*"
54 exit "$status"
57 GIT_QUIET=
59 say () {
60 if test -z "$GIT_QUIET"
61 then
62 printf '%s\n' "$*"
66 if test -n "$OPTIONS_SPEC"; then
67 usage() {
68 "$0" -h
69 exit 1
72 parseopt_extra=
73 [ -n "$OPTIONS_KEEPDASHDASH" ] &&
74 parseopt_extra="--keep-dashdash"
75 [ -n "$OPTIONS_STUCKLONG" ] &&
76 parseopt_extra="$parseopt_extra --stuck-long"
78 eval "$(
79 echo "$OPTIONS_SPEC" |
80 git rev-parse --parseopt $parseopt_extra -- "$@" ||
81 echo exit $?
83 else
84 dashless=$(basename "$0" | sed -e 's/-/ /')
85 usage() {
86 die "usage: $dashless $USAGE"
89 if [ -z "$LONG_USAGE" ]
90 then
91 LONG_USAGE="usage: $dashless $USAGE"
92 else
93 LONG_USAGE="usage: $dashless $USAGE
95 $LONG_USAGE"
98 case "$1" in
99 -h)
100 echo "$LONG_USAGE"
101 exit
102 esac
105 # Set the name of the end-user facing command in the reflog when the
106 # script may update refs. When GIT_REFLOG_ACTION is already set, this
107 # will not overwrite it, so that a scripted Porcelain (e.g. "git
108 # rebase") can set it to its own name (e.g. "rebase") and then call
109 # another scripted Porcelain (e.g. "git am") and a call to this
110 # function in the latter will keep the name of the end-user facing
111 # program (e.g. "rebase") in GIT_REFLOG_ACTION, ensuring whatever it
112 # does will be record as actions done as part of the end-user facing
113 # operation (e.g. "rebase").
115 # NOTE NOTE NOTE: consequently, after assigning a specific message to
116 # GIT_REFLOG_ACTION when calling a "git" command to record a custom
117 # reflog message, do not leave that custom value in GIT_REFLOG_ACTION,
118 # after you are done. Other callers of "git" commands that rely on
119 # writing the default "program name" in reflog expect the variable to
120 # contain the value set by this function.
122 # To use a custom reflog message, do either one of these three:
124 # (a) use a single-shot export form:
125 # GIT_REFLOG_ACTION="$GIT_REFLOG_ACTION: preparing frotz" \
126 # git command-that-updates-a-ref
128 # (b) save the original away and restore:
129 # SAVED_ACTION=$GIT_REFLOG_ACTION
130 # GIT_REFLOG_ACTION="$GIT_REFLOG_ACTION: preparing frotz"
131 # git command-that-updates-a-ref
132 # GIT_REFLOG_ACITON=$SAVED_ACTION
134 # (c) assign the variable in a subshell:
136 # GIT_REFLOG_ACTION="$GIT_REFLOG_ACTION: preparing frotz"
137 # git command-that-updates-a-ref
139 set_reflog_action() {
140 if [ -z "${GIT_REFLOG_ACTION:+set}" ]
141 then
142 GIT_REFLOG_ACTION="$*"
143 export GIT_REFLOG_ACTION
147 git_editor() {
148 if test -z "${GIT_EDITOR:+set}"
149 then
150 GIT_EDITOR="$(git var GIT_EDITOR)" || return $?
153 eval "$GIT_EDITOR" '"$@"'
156 git_pager() {
157 if test -t 1
158 then
159 GIT_PAGER=$(git var GIT_PAGER)
160 else
161 GIT_PAGER=cat
163 : ${LESS=-FRSX}
164 : ${LV=-c}
165 export LESS LV
167 eval "$GIT_PAGER" '"$@"'
170 sane_grep () {
171 GREP_OPTIONS= LC_ALL=C grep "$@"
174 sane_egrep () {
175 GREP_OPTIONS= LC_ALL=C egrep "$@"
178 is_bare_repository () {
179 git rev-parse --is-bare-repository
182 cd_to_toplevel () {
183 cdup=$(git rev-parse --show-toplevel) &&
184 cd "$cdup" || {
185 echo >&2 "Cannot chdir to $cdup, the toplevel of the working tree"
186 exit 1
190 require_work_tree_exists () {
191 if test "z$(git rev-parse --is-bare-repository)" != zfalse
192 then
193 die "fatal: $0 cannot be used without a working tree."
197 require_work_tree () {
198 test "$(git rev-parse --is-inside-work-tree 2>/dev/null)" = true ||
199 die "fatal: $0 cannot be used without a working tree."
202 require_clean_work_tree () {
203 git rev-parse --verify HEAD >/dev/null || exit 1
204 git update-index -q --ignore-submodules --refresh
205 err=0
207 if ! git diff-files --quiet --ignore-submodules
208 then
209 echo >&2 "Cannot $1: You have unstaged changes."
210 err=1
213 if ! git diff-index --cached --quiet --ignore-submodules HEAD --
214 then
215 if [ $err = 0 ]
216 then
217 echo >&2 "Cannot $1: Your index contains uncommitted changes."
218 else
219 echo >&2 "Additionally, your index contains uncommitted changes."
221 err=1
224 if [ $err = 1 ]
225 then
226 test -n "$2" && echo >&2 "$2"
227 exit 1
231 # Generate a sed script to parse identities from a commit.
233 # Reads the commit from stdin, which should be in raw format (e.g., from
234 # cat-file or "--pretty=raw").
236 # The first argument specifies the ident line to parse (e.g., "author"), and
237 # the second specifies the environment variable to put it in (e.g., "AUTHOR"
238 # for "GIT_AUTHOR_*"). Multiple pairs can be given to parse author and
239 # committer.
240 pick_ident_script () {
241 while test $# -gt 0
243 lid=$1; shift
244 uid=$1; shift
245 printf '%s' "
246 /^$lid /{
247 s/'/'\\\\''/g
249 s/^$lid "'\([^<]*\) <[^>]*> .*$/\1/'"
250 s/.*/GIT_${uid}_NAME='&'/p
253 s/^$lid "'[^<]* <\([^>]*\)> .*$/\1/'"
254 s/.*/GIT_${uid}_EMAIL='&'/p
257 s/^$lid "'[^<]* <[^>]*> \(.*\)$/@\1/'"
258 s/.*/GIT_${uid}_DATE='&'/p
261 done
262 echo '/^$/q'
265 # Create a pick-script as above and feed it to sed. Stdout is suitable for
266 # feeding to eval.
267 parse_ident_from_commit () {
268 LANG=C LC_ALL=C sed -ne "$(pick_ident_script "$@")"
271 # Parse the author from a commit given as an argument. Stdout is suitable for
272 # feeding to eval to set the usual GIT_* ident variables.
273 get_author_ident_from_commit () {
274 encoding=$(git config i18n.commitencoding || echo UTF-8)
275 git show -s --pretty=raw --encoding="$encoding" "$1" -- |
276 parse_ident_from_commit author AUTHOR
279 # Clear repo-local GIT_* environment variables. Useful when switching to
280 # another repository (e.g. when entering a submodule). See also the env
281 # list in git_connect()
282 clear_local_git_env() {
283 unset $(git rev-parse --local-env-vars)
286 # Generate a virtual base file for a two-file merge. Uses git apply to
287 # remove lines from $1 that are not in $2, leaving only common lines.
288 create_virtual_base() {
289 sz0=$(wc -c <"$1")
290 @@DIFF@@ -u -La/"$1" -Lb/"$1" "$1" "$2" | git apply --no-add
291 sz1=$(wc -c <"$1")
293 # If we do not have enough common material, it is not
294 # worth trying two-file merge using common subsections.
295 expr $sz0 \< $sz1 \* 2 >/dev/null || : >"$1"
299 # Platform specific tweaks to work around some commands
300 case $(uname -s) in
301 *MINGW*)
302 # Windows has its own (incompatible) sort and find
303 sort () {
304 /usr/bin/sort "$@"
306 find () {
307 /usr/bin/find "$@"
309 # git sees Windows-style pwd
310 pwd () {
311 builtin pwd -W
313 is_absolute_path () {
314 case "$1" in
315 [/\\]* | [A-Za-z]:*)
316 return 0 ;;
317 esac
318 return 1
322 is_absolute_path () {
323 case "$1" in
325 return 0 ;;
326 esac
327 return 1
329 esac
331 # Make sure we are in a valid repository of a vintage we understand,
332 # if we require to be in a git repository.
333 if test -z "$NONGIT_OK"
334 then
335 GIT_DIR=$(git rev-parse --git-dir) || exit
336 if [ -z "$SUBDIRECTORY_OK" ]
337 then
338 test -z "$(git rev-parse --show-cdup)" || {
339 exit=$?
340 echo >&2 "You need to run this command from the toplevel of the working tree."
341 exit $exit
344 test -n "$GIT_DIR" && GIT_DIR=$(cd "$GIT_DIR" && pwd) || {
345 echo >&2 "Unable to determine absolute path of git directory"
346 exit 1
348 : ${GIT_OBJECT_DIRECTORY="$GIT_DIR/objects"}
351 peel_committish () {
352 case "$1" in
353 :/*)
354 peeltmp=$(git rev-parse --verify "$1") &&
355 git rev-parse --verify "${peeltmp}^0"
358 git rev-parse --verify "${1}^0"
360 esac