git-sh-setup.sh

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