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
9 # But we protect ourselves from such a user mistake nevertheless.
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.
18 git_broken_path_fix () {
29 case "$SANE_TOOL_PATH:$elem" in
30 (?*:/bin | ?*:/usr/bin)
31 path="$path$sep$SANE_TOOL_PATH"
47 die_with_status 1 "$@"
53 printf >&2 '%s\n' "$*"
60 if test -z "$GIT_QUIET"
66 if test -n "$OPTIONS_SPEC"; then
73 [ -n "$OPTIONS_KEEPDASHDASH" ] &&
74 parseopt_extra="--keep-dashdash"
77 echo "$OPTIONS_SPEC" |
78 git rev-parse --parseopt $parseopt_extra -- "$@" ||
82 dashless=$(basename "$0" | sed -e 's/-/ /')
84 die "usage: $dashless $USAGE"
87 if [ -z "$LONG_USAGE" ]
89 LONG_USAGE="usage: $dashless $USAGE"
91 LONG_USAGE="usage: $dashless $USAGE
103 # Set the name of the end-user facing command in the reflog when the
104 # script may update refs. When GIT_REFLOG_ACTION is already set, this
105 # will not overwrite it, so that a scripted Porcelain (e.g. "git
106 # rebase") can set it to its own name (e.g. "rebase") and then call
107 # another scripted Porcelain (e.g. "git am") and a call to this
108 # function in the latter will keep the name of the end-user facing
109 # program (e.g. "rebase") in GIT_REFLOG_ACTION, ensuring whatever it
110 # does will be record as actions done as part of the end-user facing
111 # operation (e.g. "rebase").
113 # NOTE NOTE NOTE: consequently, after assigning a specific message to
114 # GIT_REFLOG_ACTION when calling a "git" command to record a custom
115 # reflog message, do not leave that custom value in GIT_REFLOG_ACTION,
116 # after you are done. Other callers of "git" commands that rely on
117 # writing the default "program name" in reflog expect the variable to
118 # contain the value set by this function.
120 # To use a custom reflog message, do either one of these three:
122 # (a) use a single-shot export form:
123 # GIT_REFLOG_ACTION="$GIT_REFLOG_ACTION: preparing frotz" \
124 # git command-that-updates-a-ref
126 # (b) save the original away and restore:
127 # SAVED_ACTION=$GIT_REFLOG_ACTION
128 # GIT_REFLOG_ACTION="$GIT_REFLOG_ACTION: preparing frotz"
129 # git command-that-updates-a-ref
130 # GIT_REFLOG_ACITON=$SAVED_ACTION
132 # (c) assign the variable in a subshell:
134 # GIT_REFLOG_ACTION="$GIT_REFLOG_ACTION: preparing frotz"
135 # git command-that-updates-a-ref
137 set_reflog_action() {
138 if [ -z "${GIT_REFLOG_ACTION:+set}" ]
140 GIT_REFLOG_ACTION="$*"
141 export GIT_REFLOG_ACTION
146 if test -z "${GIT_EDITOR:+set}"
148 GIT_EDITOR="$(git var GIT_EDITOR)" || return $?
151 eval "$GIT_EDITOR" '"$@"'
157 GIT_PAGER=$(git var GIT_PAGER)
165 eval "$GIT_PAGER" '"$@"'
169 GREP_OPTIONS= LC_ALL=C grep "$@"
173 GREP_OPTIONS= LC_ALL=C egrep "$@"
176 is_bare_repository () {
177 git rev-parse --is-bare-repository
181 cdup=$(git rev-parse --show-toplevel) &&
183 echo >&2 "Cannot chdir to $cdup, the toplevel of the working tree"
188 require_work_tree_exists () {
189 if test "z$(git rev-parse --is-bare-repository)" != zfalse
191 die "fatal: $0 cannot be used without a working tree."
195 require_work_tree () {
196 test "$(git rev-parse --is-inside-work-tree 2>/dev/null)" = true ||
197 die "fatal: $0 cannot be used without a working tree."
200 require_clean_work_tree () {
201 git rev-parse --verify HEAD >/dev/null || exit 1
202 git update-index -q --ignore-submodules --refresh
205 if ! git diff-files --quiet --ignore-submodules
207 echo >&2 "Cannot $1: You have unstaged changes."
211 if ! git diff-index --cached --quiet --ignore-submodules HEAD --
215 echo >&2 "Cannot $1: Your index contains uncommitted changes."
217 echo >&2 "Additionally, your index contains uncommitted changes."
224 test -n "$2" && echo >&2 "$2"
229 # Generate a sed script to parse identities from a commit.
231 # Reads the commit from stdin, which should be in raw format (e.g., from
232 # cat-file or "--pretty=raw").
234 # The first argument specifies the ident line to parse (e.g., "author"), and
235 # the second specifies the environment variable to put it in (e.g., "AUTHOR"
236 # for "GIT_AUTHOR_*"). Multiple pairs can be given to parse author and
238 pick_ident_script () {
247 s/^$lid "'\([^<]*\) <[^>]*> .*$/\1/'"
248 s/.*/GIT_${uid}_NAME='&'/p
251 s/^$lid "'[^<]* <\([^>]*\)> .*$/\1/'"
252 s/.*/GIT_${uid}_EMAIL='&'/p
255 s/^$lid "'[^<]* <[^>]*> \(.*\)$/@\1/'"
256 s/.*/GIT_${uid}_DATE='&'/p
263 # Create a pick-script as above and feed it to sed. Stdout is suitable for
265 parse_ident_from_commit () {
266 LANG=C LC_ALL=C sed -ne "$(pick_ident_script "$@")"
269 # Parse the author from a commit given as an argument. Stdout is suitable for
270 # feeding to eval to set the usual GIT_* ident variables.
271 get_author_ident_from_commit () {
272 encoding=$(git config i18n.commitencoding || echo UTF-8)
273 git show -s --pretty=raw --encoding="$encoding" "$1" -- |
274 parse_ident_from_commit author AUTHOR
277 # Clear repo-local GIT_* environment variables. Useful when switching to
278 # another repository (e.g. when entering a submodule). See also the env
279 # list in git_connect()
280 clear_local_git_env() {
281 unset $(git rev-parse --local-env-vars)
284 # Generate a virtual base file for a two-file merge. Uses git apply to
285 # remove lines from $1 that are not in $2, leaving only common lines.
286 create_virtual_base() {
288 @@DIFF@@ -u -La/"$1" -Lb/"$1" "$1" "$2" | git apply --no-add
291 # If we do not have enough common material, it is not
292 # worth trying two-file merge using common subsections.
293 expr $sz0 \< $sz1 \* 2 >/dev/null || : >"$1"
297 # Platform specific tweaks to work around some commands
300 # Windows has its own (incompatible) sort and find
307 # git sees Windows-style pwd
311 is_absolute_path () {
320 is_absolute_path () {
329 # Make sure we are in a valid repository of a vintage we understand,
330 # if we require to be in a git repository.
331 if test -z "$NONGIT_OK"
333 GIT_DIR=$(git rev-parse --git-dir) || exit
334 if [ -z "$SUBDIRECTORY_OK" ]
336 test -z "$(git rev-parse --show-cdup)" || {
338 echo >&2 "You need to run this command from the toplevel of the working tree."
342 test -n "$GIT_DIR" && GIT_DIR=$(cd "$GIT_DIR" && pwd) || {
343 echo >&2 "Unable to determine absolute path of git directory"
346 : ${GIT_OBJECT_DIRECTORY="$GIT_DIR/objects"}
352 peeltmp=$(git rev-parse --verify "$1") &&
353 git rev-parse --verify "${peeltmp}^0"
356 git rev-parse --verify "${1}^0"