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. 4 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. 10unset CDPATH 11 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. 15IFS=' 16' 17 18git_broken_path_fix () { 19case":$PATH:"in 20*:$1:*) : ok ;; 21*) 22 PATH=$( 23 SANE_TOOL_PATH="$1" 24 IFS=: path= sep= 25set x $PATH 26shift 27for elem 28do 29case"$SANE_TOOL_PATH:$elem"in 30(?*:/bin | ?*:/usr/bin) 31 path="$path$sep$SANE_TOOL_PATH" 32 sep=: 33 SANE_TOOL_PATH= 34esac 35 path="$path$sep$elem" 36 sep=: 37done 38echo"$path" 39) 40;; 41esac 42} 43 44# @@BROKEN_PATH_FIX@@ 45 46die () { 47 die_with_status 1"$@" 48} 49 50die_with_status () { 51 status=$1 52shift 53printf>&2'%s\n'"$*" 54exit"$status" 55} 56 57GIT_QUIET= 58 59say () { 60iftest -z"$GIT_QUIET" 61then 62printf'%s\n'"$*" 63fi 64} 65 66iftest -n"$OPTIONS_SPEC";then 67 usage() { 68"$0"-h 69exit1 70} 71 72 parseopt_extra= 73[-n"$OPTIONS_KEEPDASHDASH"] && 74 parseopt_extra="--keep-dashdash" 75[-n"$OPTIONS_STUCKLONG"] && 76 parseopt_extra="$parseopt_extra--stuck-long" 77 78eval"$( 79 echo "$OPTIONS_SPEC" | 80 git rev-parse --parseopt$parseopt_extra-- "$@" || 81 echo exit $? 82 )" 83else 84 dashless=$(basename -- "$0" | sed -e 's/-/ /') 85 usage() { 86 die "usage:$dashless$USAGE" 87} 88 89if[-z"$LONG_USAGE"] 90then 91 LONG_USAGE="usage:$dashless$USAGE" 92else 93 LONG_USAGE="usage:$dashless$USAGE 94 95$LONG_USAGE" 96fi 97 98case"$1"in 99-h) 100echo"$LONG_USAGE" 101exit 102esac 103fi 104 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"). 114# 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. 121# 122# To use a custom reflog message, do either one of these three: 123# 124# (a) use a single-shot export form: 125# GIT_REFLOG_ACTION="$GIT_REFLOG_ACTION: preparing frotz" \ 126# git command-that-updates-a-ref 127# 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 133# 134# (c) assign the variable in a subshell: 135# ( 136# GIT_REFLOG_ACTION="$GIT_REFLOG_ACTION: preparing frotz" 137# git command-that-updates-a-ref 138# ) 139set_reflog_action() { 140if[-z"${GIT_REFLOG_ACTION:+set}"] 141then 142 GIT_REFLOG_ACTION="$*" 143export GIT_REFLOG_ACTION 144fi 145} 146 147git_editor() { 148iftest -z"${GIT_EDITOR:+set}" 149then 150 GIT_EDITOR="$(git var GIT_EDITOR)"||return $? 151fi 152 153eval"$GIT_EDITOR"'"$@"' 154} 155 156git_pager() { 157iftest -t1 158then 159 GIT_PAGER=$(git var GIT_PAGER) 160else 161 GIT_PAGER=cat 162fi 163for vardef in @@PAGER_ENV@@ 164do 165 var=${vardef%%=*} 166eval":\"\${$vardef}\"&& export$var" 167done 168 169eval"$GIT_PAGER"'"$@"' 170} 171 172sane_grep () { 173 GREP_OPTIONS= LC_ALL=C grep @@SANE_TEXT_GREP@@ "$@" 174} 175 176sane_egrep () { 177 GREP_OPTIONS= LC_ALL=C egrep @@SANE_TEXT_GREP@@ "$@" 178} 179 180is_bare_repository () { 181 git rev-parse --is-bare-repository 182} 183 184cd_to_toplevel () { 185 cdup=$(git rev-parse --show-toplevel)&& 186cd"$cdup"|| { 187echo>&2"Cannot chdir to$cdup, the toplevel of the working tree" 188exit1 189} 190} 191 192require_work_tree_exists () { 193iftest"z$(git rev-parse --is-bare-repository)"!= zfalse 194then 195 die "fatal:$0cannot be used without a working tree." 196fi 197} 198 199require_work_tree () { 200test"$(git rev-parse --is-inside-work-tree 2>/dev/null)"= true || 201 die "fatal:$0cannot be used without a working tree." 202} 203 204require_clean_work_tree () { 205 git rev-parse --verify HEAD >/dev/null ||exit1 206 git update-index -q --ignore-submodules --refresh 207 err=0 208 209if! git diff-files --quiet --ignore-submodules 210then 211echo>&2"Cannot$1: You have unstaged changes." 212 err=1 213fi 214 215if! git diff-index --cached --quiet --ignore-submodules HEAD -- 216then 217if[$err=0] 218then 219echo>&2"Cannot$1: Your index contains uncommitted changes." 220else 221echo>&2"Additionally, your index contains uncommitted changes." 222fi 223 err=1 224fi 225 226if[$err=1] 227then 228test -n"$2"&&echo>&2"$2" 229exit1 230fi 231} 232 233# Generate a sed script to parse identities from a commit. 234# 235# Reads the commit from stdin, which should be in raw format (e.g., from 236# cat-file or "--pretty=raw"). 237# 238# The first argument specifies the ident line to parse (e.g., "author"), and 239# the second specifies the environment variable to put it in (e.g., "AUTHOR" 240# for "GIT_AUTHOR_*"). Multiple pairs can be given to parse author and 241# committer. 242pick_ident_script () { 243whiletest$#-gt0 244do 245 lid=$1;shift 246 uid=$1;shift 247printf'%s'" 248 /^$lid/{ 249 s/'/'\\\\''/g 250 h 251 s/^$lid"'\([^<]*\) <[^>]*> .*$/\1/'" 252 s/.*/GIT_${uid}_NAME='&'/p 253 254 g 255 s/^$lid"'[^<]* <\([^>]*\)> .*$/\1/'" 256 s/.*/GIT_${uid}_EMAIL='&'/p 257 258 g 259 s/^$lid"'[^<]* <[^>]*> \(.*\)$/@\1/'" 260 s/.*/GIT_${uid}_DATE='&'/p 261 } 262 " 263done 264echo'/^$/q' 265} 266 267# Create a pick-script as above and feed it to sed. Stdout is suitable for 268# feeding to eval. 269parse_ident_from_commit () { 270 LANG=C LC_ALL=C sed-ne"$(pick_ident_script "$@")" 271} 272 273# Parse the author from a commit given as an argument. Stdout is suitable for 274# feeding to eval to set the usual GIT_* ident variables. 275get_author_ident_from_commit () { 276 encoding=$(git config i18n.commitencoding || echo UTF-8) 277 git show -s --pretty=raw --encoding="$encoding""$1"--| 278 parse_ident_from_commit author AUTHOR 279} 280 281# Clear repo-local GIT_* environment variables. Useful when switching to 282# another repository (e.g. when entering a submodule). See also the env 283# list in git_connect() 284clear_local_git_env() { 285unset$(git rev-parse --local-env-vars) 286} 287 288# Generate a virtual base file for a two-file merge. Uses git apply to 289# remove lines from $1 that are not in $2, leaving only common lines. 290create_virtual_base() { 291 sz0=$(wc -c <"$1") 292 @@DIFF@@ -u -La/"$1"-Lb/"$1""$1""$2"| git apply --no-add 293 sz1=$(wc -c <"$1") 294 295# If we do not have enough common material, it is not 296# worth trying two-file merge using common subsections. 297expr$sz0 \<$sz1 \*2>/dev/null || : >"$1" 298} 299 300 301# Platform specific tweaks to work around some commands 302case$(uname -s)in 303*MINGW*) 304# Windows has its own (incompatible) sort and find 305sort() { 306/usr/bin/sort"$@" 307} 308find() { 309/usr/bin/find"$@" 310} 311# git sees Windows-style pwd 312pwd() { 313builtin pwd -W 314} 315 is_absolute_path () { 316case"$1"in 317[/\\]* | [A-Za-z]:*) 318return0;; 319esac 320return1 321} 322;; 323*) 324 is_absolute_path () { 325case"$1"in 326/*) 327return0;; 328esac 329return1 330} 331esac 332 333# Make sure we are in a valid repository of a vintage we understand, 334# if we require to be in a git repository. 335git_dir_init () { 336 GIT_DIR=$(git rev-parse --git-dir)||exit 337if[-z"$SUBDIRECTORY_OK"] 338then 339test -z"$(git rev-parse --show-cdup)"|| { 340exit=$? 341echo>&2"You need to run this command from the toplevel of the working tree." 342exit$exit 343} 344fi 345test -n"$GIT_DIR"&& GIT_DIR=$(cd "$GIT_DIR" && pwd)|| { 346echo>&2"Unable to determine absolute path of git directory" 347exit1 348} 349:"${GIT_OBJECT_DIRECTORY="$(git rev-parse --git-path objects)"}" 350} 351 352iftest -z"$NONGIT_OK" 353then 354 git_dir_init 355fi 356 357peel_committish () { 358case"$1"in 359:/*) 360 peeltmp=$(git rev-parse --verify "$1")&& 361 git rev-parse --verify"${peeltmp}^0" 362;; 363*) 364 git rev-parse --verify"${1}^0" 365;; 366esac 367}