Andrew's git - gitweb.git/blob

   1#!/bin/sh
   2#
   3# This is included in commands that either have to be run from the toplevel
   4# of the repository, or with GIT_DIR environment variable properly.
   5# If the GIT_DIR does not look like the right correct git-repository,
   6# it dies.
   7
   8# Having this variable in your environment would break scripts because
   9# you would cause "cd" to be taken to unexpected places.  If you
  10# like CDPATH, define it for your interactive shell sessions without
  11# exporting it.
  12# But we protect ourselves from such a user mistake nevertheless.
  13unset CDPATH
  14
  15# Similarly for IFS, but some shells (e.g. FreeBSD 7.2) are buggy and
  16# do not equate an unset IFS with IFS with the default, so here is
  17# an explicit SP HT LF.
  18IFS='   
  19'
  20
  21git_broken_path_fix () {
  22        case ":$PATH:" in
  23        *:$1:*) : ok ;;
  24        *)
  25                PATH=$(
  26                        SANE_TOOL_PATH="$1"
  27                        IFS=: path= sep=
  28                        set x $PATH
  29                        shift
  30                        for elem
  31                        do
  32                                case "$SANE_TOOL_PATH:$elem" in
  33                                (?*:/bin | ?*:/usr/bin)
  34                                        path="$path$sep$SANE_TOOL_PATH"
  35                                        sep=:
  36                                        SANE_TOOL_PATH=
  37                                esac
  38                                path="$path$sep$elem"
  39                                sep=:
  40                        done
  41                        echo "$path"
  42                )
  43                ;;
  44        esac
  45}
  46
  47# @@BROKEN_PATH_FIX@@
  48
  49die () {
  50        die_with_status 1 "$@"
  51}
  52
  53die_with_status () {
  54        status=$1
  55        shift
  56        printf >&2 '%s\n' "$*"
  57        exit "$status"
  58}
  59
  60GIT_QUIET=
  61
  62say () {
  63        if test -z "$GIT_QUIET"
  64        then
  65                printf '%s\n' "$*"
  66        fi
  67}
  68
  69if 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
  79        eval "$(
  80                echo "$OPTIONS_SPEC" |
  81                        git rev-parse --parseopt $parseopt_extra -- "$@" ||
  82                echo exit $?
  83        )"
  84else
  85        dashless=$(basename "$0" | sed -e 's/-/ /')
  86        usage() {
  87                die "usage: $dashless $USAGE"
  88        }
  89
  90        if [ -z "$LONG_USAGE" ]
  91        then
  92                LONG_USAGE="usage: $dashless $USAGE"
  93        else
  94                LONG_USAGE="usage: $dashless $USAGE
  95
  96$LONG_USAGE"
  97        fi
  98
  99        case "$1" in
 100                -h)
 101                echo "$LONG_USAGE"
 102                exit
 103        esac
 104fi
 105
 106# Set the name of the end-user facing command in the reflog when the
 107# script may update refs.  When GIT_REFLOG_ACTION is already set, this
 108# will not overwrite it, so that a scripted Porcelain (e.g. "git
 109# rebase") can set it to its own name (e.g. "rebase") and then call
 110# another scripted Porcelain (e.g. "git am") and a call to this
 111# function in the latter will keep the name of the end-user facing
 112# program (e.g. "rebase") in GIT_REFLOG_ACTION, ensuring whatever it
 113# does will be record as actions done as part of the end-user facing
 114# operation (e.g. "rebase").
 115#
 116# NOTE NOTE NOTE: consequently, after assigning a specific message to
 117# GIT_REFLOG_ACTION when calling a "git" command to record a custom
 118# reflog message, do not leave that custom value in GIT_REFLOG_ACTION,
 119# after you are done.  Other callers of "git" commands that rely on
 120# writing the default "program name" in reflog expect the variable to
 121# contain the value set by this function.
 122#
 123# To use a custom reflog message, do either one of these three:
 124#
 125# (a) use a single-shot export form:
 126#     GIT_REFLOG_ACTION="$GIT_REFLOG_ACTION: preparing frotz" \
 127#         git command-that-updates-a-ref
 128#
 129# (b) save the original away and restore:
 130#     SAVED_ACTION=$GIT_REFLOG_ACTION
 131#     GIT_REFLOG_ACTION="$GIT_REFLOG_ACTION: preparing frotz"
 132#     git command-that-updates-a-ref
 133#     GIT_REFLOG_ACITON=$SAVED_ACTION
 134#
 135# (c) assign the variable in a subshell:
 136#     (
 137#         GIT_REFLOG_ACTION="$GIT_REFLOG_ACTION: preparing frotz"
 138#         git command-that-updates-a-ref
 139#     )
 140set_reflog_action() {
 141        if [ -z "${GIT_REFLOG_ACTION:+set}" ]
 142        then
 143                GIT_REFLOG_ACTION="$*"
 144                export GIT_REFLOG_ACTION
 145        fi
 146}
 147
 148git_editor() {
 149        if test -z "${GIT_EDITOR:+set}"
 150        then
 151                GIT_EDITOR="$(git var GIT_EDITOR)" || return $?
 152        fi
 153
 154        eval "$GIT_EDITOR" '"$@"'
 155}
 156
 157git_pager() {
 158        if test -t 1
 159        then
 160                GIT_PAGER=$(git var GIT_PAGER)
 161        else
 162                GIT_PAGER=cat
 163        fi
 164        : ${LESS=-FRSX}
 165        export LESS
 166
 167        eval "$GIT_PAGER" '"$@"'
 168}
 169
 170sane_grep () {
 171        GREP_OPTIONS= LC_ALL=C grep "$@"
 172}
 173
 174sane_egrep () {
 175        GREP_OPTIONS= LC_ALL=C egrep "$@"
 176}
 177
 178is_bare_repository () {
 179        git rev-parse --is-bare-repository
 180}
 181
 182cd_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
 187        }
 188}
 189
 190require_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."
 194        fi
 195}
 196
 197require_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."
 200}
 201
 202require_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                echo >&2 "Cannot $1: You have unstaged changes."
 210                err=1
 211        fi
 212
 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."
 220                fi
 221                err=1
 222        fi
 223
 224        if [ $err = 1 ]
 225        then
 226                test -n "$2" && echo >&2 "$2"
 227                exit 1
 228        fi
 229}
 230
 231# Generate a sed script to parse identities from a commit.
 232#
 233# Reads the commit from stdin, which should be in raw format (e.g., from
 234# cat-file or "--pretty=raw").
 235#
 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.
 240pick_ident_script () {
 241        while test $# -gt 0
 242        do
 243                lid=$1; shift
 244                uid=$1; shift
 245                printf '%s' "
 246                /^$lid /{
 247                        s/'/'\\\\''/g
 248                        h
 249                        s/^$lid "'\([^<]*\) <[^>]*> .*$/\1/'"
 250                        s/.*/GIT_${uid}_NAME='&'/p
 251
 252                        g
 253                        s/^$lid "'[^<]* <\([^>]*\)> .*$/\1/'"
 254                        s/.*/GIT_${uid}_EMAIL='&'/p
 255
 256                        g
 257                        s/^$lid "'[^<]* <[^>]*> \(.*\)$/@\1/'"
 258                        s/.*/GIT_${uid}_DATE='&'/p
 259                }
 260                "
 261        done
 262        echo '/^$/q'
 263}
 264
 265# Create a pick-script as above and feed it to sed. Stdout is suitable for
 266# feeding to eval.
 267parse_ident_from_commit () {
 268        LANG=C LC_ALL=C sed -ne "$(pick_ident_script "$@")"
 269}
 270
 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.
 273get_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
 277}
 278
 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()
 282clear_local_git_env() {
 283        unset $(git rev-parse --local-env-vars)
 284}
 285
 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.
 288create_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")
 292
 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"
 296}
 297
 298
 299# Platform specific tweaks to work around some commands
 300case $(uname -s) in
 301*MINGW*)
 302        # Windows has its own (incompatible) sort and find
 303        sort () {
 304                /usr/bin/sort "$@"
 305        }
 306        find () {
 307                /usr/bin/find "$@"
 308        }
 309        # git sees Windows-style pwd
 310        pwd () {
 311                builtin pwd -W
 312        }
 313        is_absolute_path () {
 314                case "$1" in
 315                [/\\]* | [A-Za-z]:*)
 316                        return 0 ;;
 317                esac
 318                return 1
 319        }
 320        ;;
 321*)
 322        is_absolute_path () {
 323                case "$1" in
 324                /*)
 325                        return 0 ;;
 326                esac
 327                return 1
 328        }
 329esac
 330
 331# Make sure we are in a valid repository of a vintage we understand,
 332# if we require to be in a git repository.
 333if test -z "$NONGIT_OK"
 334then
 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
 342                }
 343        fi
 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
 347        }
 348        : ${GIT_OBJECT_DIRECTORY="$GIT_DIR/objects"}
 349fi
 350
 351peel_committish () {
 352        case "$1" in
 353        :/*)
 354                peeltmp=$(git rev-parse --verify "$1") &&
 355                git rev-parse --verify "${peeltmp}^0"
 356                ;;
 357        *)
 358                git rev-parse --verify "${1}^0"
 359                ;;
 360        esac
 361}