Merge branch 'master' of github.com:git/git
[alt-git.git] / git-sh-setup.sh
blob960982f9d534f4984f4e372a1883899293c536ff
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 # Source git-sh-i18n for gettext support.
47 . "$(git --exec-path)/git-sh-i18n"
49 die () {
50 die_with_status 1 "$@"
53 die_with_status () {
54 status=$1
55 shift
56 printf >&2 '%s\n' "$*"
57 exit "$status"
60 GIT_QUIET=
62 say () {
63 if test -z "$GIT_QUIET"
64 then
65 printf '%s\n' "$*"
69 if test -n "$OPTIONS_SPEC"; then
70 usage() {
71 "$0" -h
72 exit 1
75 parseopt_extra=
76 [ -n "$OPTIONS_KEEPDASHDASH" ] &&
77 parseopt_extra="--keep-dashdash"
78 [ -n "$OPTIONS_STUCKLONG" ] &&
79 parseopt_extra="$parseopt_extra --stuck-long"
81 eval "$(
82 echo "$OPTIONS_SPEC" |
83 git rev-parse --parseopt $parseopt_extra -- "$@" ||
84 echo exit $?
86 else
87 dashless=$(basename -- "$0" | sed -e 's/-/ /')
88 usage() {
89 die "$(eval_gettext "usage: \$dashless \$USAGE")"
92 if [ -z "$LONG_USAGE" ]
93 then
94 LONG_USAGE="$(eval_gettext "usage: \$dashless \$USAGE")"
95 else
96 LONG_USAGE="$(eval_gettext "usage: \$dashless \$USAGE
98 $LONG_USAGE")"
101 case "$1" in
103 echo "$LONG_USAGE"
104 case "$0" in *git-legacy-stash) exit 129;; esac
105 exit
106 esac
109 # Set the name of the end-user facing command in the reflog when the
110 # script may update refs. When GIT_REFLOG_ACTION is already set, this
111 # will not overwrite it, so that a scripted Porcelain (e.g. "git
112 # rebase") can set it to its own name (e.g. "rebase") and then call
113 # another scripted Porcelain (e.g. "git am") and a call to this
114 # function in the latter will keep the name of the end-user facing
115 # program (e.g. "rebase") in GIT_REFLOG_ACTION, ensuring whatever it
116 # does will be record as actions done as part of the end-user facing
117 # operation (e.g. "rebase").
119 # NOTE NOTE NOTE: consequently, after assigning a specific message to
120 # GIT_REFLOG_ACTION when calling a "git" command to record a custom
121 # reflog message, do not leave that custom value in GIT_REFLOG_ACTION,
122 # after you are done. Other callers of "git" commands that rely on
123 # writing the default "program name" in reflog expect the variable to
124 # contain the value set by this function.
126 # To use a custom reflog message, do either one of these three:
128 # (a) use a single-shot export form:
129 # GIT_REFLOG_ACTION="$GIT_REFLOG_ACTION: preparing frotz" \
130 # git command-that-updates-a-ref
132 # (b) save the original away and restore:
133 # SAVED_ACTION=$GIT_REFLOG_ACTION
134 # GIT_REFLOG_ACTION="$GIT_REFLOG_ACTION: preparing frotz"
135 # git command-that-updates-a-ref
136 # GIT_REFLOG_ACITON=$SAVED_ACTION
138 # (c) assign the variable in a subshell:
140 # GIT_REFLOG_ACTION="$GIT_REFLOG_ACTION: preparing frotz"
141 # git command-that-updates-a-ref
143 set_reflog_action() {
144 if [ -z "${GIT_REFLOG_ACTION:+set}" ]
145 then
146 GIT_REFLOG_ACTION="$*"
147 export GIT_REFLOG_ACTION
151 git_editor() {
152 if test -z "${GIT_EDITOR:+set}"
153 then
154 GIT_EDITOR="$(git var GIT_EDITOR)" || return $?
157 eval "$GIT_EDITOR" '"$@"'
160 git_pager() {
161 if test -t 1
162 then
163 GIT_PAGER=$(git var GIT_PAGER)
164 else
165 GIT_PAGER=cat
167 for vardef in @@PAGER_ENV@@
169 var=${vardef%%=*}
170 eval ": \"\${$vardef}\" && export $var"
171 done
173 eval "$GIT_PAGER" '"$@"'
176 sane_grep () {
177 GREP_OPTIONS= LC_ALL=C grep @@SANE_TEXT_GREP@@ "$@"
180 sane_egrep () {
181 GREP_OPTIONS= LC_ALL=C egrep @@SANE_TEXT_GREP@@ "$@"
184 is_bare_repository () {
185 git rev-parse --is-bare-repository
188 cd_to_toplevel () {
189 cdup=$(git rev-parse --show-toplevel) &&
190 cd "$cdup" || {
191 gettextln "Cannot chdir to \$cdup, the toplevel of the working tree" >&2
192 exit 1
196 require_work_tree_exists () {
197 if test "z$(git rev-parse --is-bare-repository)" != zfalse
198 then
199 program_name=$0
200 die "$(eval_gettext "fatal: \$program_name cannot be used without a working tree.")"
204 require_work_tree () {
205 test "$(git rev-parse --is-inside-work-tree 2>/dev/null)" = true || {
206 program_name=$0
207 die "$(eval_gettext "fatal: \$program_name cannot be used without a working tree.")"
211 require_clean_work_tree () {
212 git rev-parse --verify HEAD >/dev/null || exit 1
213 git update-index -q --ignore-submodules --refresh
214 err=0
216 if ! git diff-files --quiet --ignore-submodules
217 then
218 action=$1
219 case "$action" in
220 "rewrite branches")
221 gettextln "Cannot rewrite branches: You have unstaged changes." >&2
224 eval_gettextln "Cannot \$action: You have unstaged changes." >&2
226 esac
227 err=1
230 if ! git diff-index --cached --quiet --ignore-submodules HEAD --
231 then
232 if test $err = 0
233 then
234 action=$1
235 eval_gettextln "Cannot \$action: Your index contains uncommitted changes." >&2
236 else
237 gettextln "Additionally, your index contains uncommitted changes." >&2
239 err=1
242 if test $err = 1
243 then
244 test -n "$2" && echo "$2" >&2
245 exit 1
249 # Generate a sed script to parse identities from a commit.
251 # Reads the commit from stdin, which should be in raw format (e.g., from
252 # cat-file or "--pretty=raw").
254 # The first argument specifies the ident line to parse (e.g., "author"), and
255 # the second specifies the environment variable to put it in (e.g., "AUTHOR"
256 # for "GIT_AUTHOR_*"). Multiple pairs can be given to parse author and
257 # committer.
258 pick_ident_script () {
259 while test $# -gt 0
261 lid=$1; shift
262 uid=$1; shift
263 printf '%s' "
264 /^$lid /{
265 s/'/'\\\\''/g
267 s/^$lid "'\([^<]*\) <[^>]*> .*$/\1/'"
268 s/.*/GIT_${uid}_NAME='&'/p
271 s/^$lid "'[^<]* <\([^>]*\)> .*$/\1/'"
272 s/.*/GIT_${uid}_EMAIL='&'/p
275 s/^$lid "'[^<]* <[^>]*> \(.*\)$/@\1/'"
276 s/.*/GIT_${uid}_DATE='&'/p
279 done
280 echo '/^$/q'
283 # Create a pick-script as above and feed it to sed. Stdout is suitable for
284 # feeding to eval.
285 parse_ident_from_commit () {
286 LANG=C LC_ALL=C sed -ne "$(pick_ident_script "$@")"
289 # Parse the author from a commit given as an argument. Stdout is suitable for
290 # feeding to eval to set the usual GIT_* ident variables.
291 get_author_ident_from_commit () {
292 encoding=$(git config i18n.commitencoding || echo UTF-8)
293 git show -s --pretty=raw --encoding="$encoding" "$1" -- |
294 parse_ident_from_commit author AUTHOR
297 # Clear repo-local GIT_* environment variables. Useful when switching to
298 # another repository (e.g. when entering a submodule). See also the env
299 # list in git_connect()
300 clear_local_git_env() {
301 unset $(git rev-parse --local-env-vars)
304 # Generate a virtual base file for a two-file merge. Uses git apply to
305 # remove lines from $1 that are not in $2, leaving only common lines.
306 create_virtual_base() {
307 sz0=$(wc -c <"$1")
308 @@DIFF@@ -u -La/"$1" -Lb/"$1" "$1" "$2" | git apply --no-add
309 sz1=$(wc -c <"$1")
311 # If we do not have enough common material, it is not
312 # worth trying two-file merge using common subsections.
313 expr $sz0 \< $sz1 \* 2 >/dev/null || : >"$1"
317 # Platform specific tweaks to work around some commands
318 case $(uname -s) in
319 *MINGW*)
320 # Windows has its own (incompatible) sort and find
321 sort () {
322 /usr/bin/sort "$@"
324 find () {
325 /usr/bin/find "$@"
327 # git sees Windows-style pwd
328 pwd () {
329 builtin pwd -W
331 is_absolute_path () {
332 case "$1" in
333 [/\\]* | [A-Za-z]:*)
334 return 0 ;;
335 esac
336 return 1
340 is_absolute_path () {
341 case "$1" in
343 return 0 ;;
344 esac
345 return 1
347 esac
349 # Make sure we are in a valid repository of a vintage we understand,
350 # if we require to be in a git repository.
351 git_dir_init () {
352 GIT_DIR=$(git rev-parse --git-dir) || exit
353 if [ -z "$SUBDIRECTORY_OK" ]
354 then
355 test -z "$(git rev-parse --show-cdup)" || {
356 exit=$?
357 gettextln "You need to run this command from the toplevel of the working tree." >&2
358 exit $exit
361 test -n "$GIT_DIR" && GIT_DIR=$(cd "$GIT_DIR" && pwd) || {
362 gettextln "Unable to determine absolute path of git directory" >&2
363 exit 1
365 : "${GIT_OBJECT_DIRECTORY="$(git rev-parse --git-path objects)"}"
368 if test -z "$NONGIT_OK"
369 then
370 git_dir_init
373 peel_committish () {
374 case "$1" in
375 :/*)
376 peeltmp=$(git rev-parse --verify "$1") &&
377 git rev-parse --verify "${peeltmp}^0"
380 git rev-parse --verify "${1}^0"
382 esac