git-pull.shon commit Documentation/config.txt: describe the structure first and then meaning (ff5507e)
   1#!/bin/sh
   2#
   3# Copyright (c) 2005 Junio C Hamano
   4#
   5# Fetch one or more remote refs and merge it/them into the current HEAD.
   6
   7USAGE='[-n | --no-stat] [--[no-]commit] [--[no-]squash] [--[no-]ff] [--[no-]rebase|--rebase=preserve] [-s strategy]... [<fetch-options>] <repo> <head>...'
   8LONG_USAGE='Fetch one or more remote refs and integrate it/them with the current HEAD.'
   9SUBDIRECTORY_OK=Yes
  10OPTIONS_SPEC=
  11. git-sh-setup
  12. git-sh-i18n
  13set_reflog_action "pull${1+ $*}"
  14require_work_tree_exists
  15cd_to_toplevel
  16
  17
  18die_conflict () {
  19    git diff-index --cached --name-status -r --ignore-submodules HEAD --
  20    if [ $(git config --bool --get advice.resolveConflict || echo true) = "true" ]; then
  21        die "$(gettext "Pull is not possible because you have unmerged files.
  22Please, fix them up in the work tree, and then use 'git add/rm <file>'
  23as appropriate to mark resolution, or use 'git commit -a'.")"
  24    else
  25        die "$(gettext "Pull is not possible because you have unmerged files.")"
  26    fi
  27}
  28
  29die_merge () {
  30    if [ $(git config --bool --get advice.resolveConflict || echo true) = "true" ]; then
  31        die "$(gettext "You have not concluded your merge (MERGE_HEAD exists).
  32Please, commit your changes before you can merge.")"
  33    else
  34        die "$(gettext "You have not concluded your merge (MERGE_HEAD exists).")"
  35    fi
  36}
  37
  38test -z "$(git ls-files -u)" || die_conflict
  39test -f "$GIT_DIR/MERGE_HEAD" && die_merge
  40
  41bool_or_string_config () {
  42        git config --bool "$1" 2>/dev/null || git config "$1"
  43}
  44
  45strategy_args= diffstat= no_commit= squash= no_ff= ff_only=
  46log_arg= verbosity= progress= recurse_submodules= verify_signatures=
  47merge_args= edit= rebase_args=
  48curr_branch=$(git symbolic-ref -q HEAD)
  49curr_branch_short="${curr_branch#refs/heads/}"
  50rebase=$(bool_or_string_config branch.$curr_branch_short.rebase)
  51if test -z "$rebase"
  52then
  53        rebase=$(bool_or_string_config pull.rebase)
  54fi
  55dry_run=
  56while :
  57do
  58        case "$1" in
  59        -q|--quiet)
  60                verbosity="$verbosity -q" ;;
  61        -v|--verbose)
  62                verbosity="$verbosity -v" ;;
  63        --progress)
  64                progress=--progress ;;
  65        --no-progress)
  66                progress=--no-progress ;;
  67        -n|--no-stat|--no-summary)
  68                diffstat=--no-stat ;;
  69        --stat|--summary)
  70                diffstat=--stat ;;
  71        --log|--no-log)
  72                log_arg=$1 ;;
  73        --no-c|--no-co|--no-com|--no-comm|--no-commi|--no-commit)
  74                no_commit=--no-commit ;;
  75        --c|--co|--com|--comm|--commi|--commit)
  76                no_commit=--commit ;;
  77        -e|--edit)
  78                edit=--edit ;;
  79        --no-edit)
  80                edit=--no-edit ;;
  81        --sq|--squ|--squa|--squas|--squash)
  82                squash=--squash ;;
  83        --no-sq|--no-squ|--no-squa|--no-squas|--no-squash)
  84                squash=--no-squash ;;
  85        --ff)
  86                no_ff=--ff ;;
  87        --no-ff)
  88                no_ff=--no-ff ;;
  89        --ff-only)
  90                ff_only=--ff-only ;;
  91        -s=*|--s=*|--st=*|--str=*|--stra=*|--strat=*|--strate=*|\
  92                --strateg=*|--strategy=*|\
  93        -s|--s|--st|--str|--stra|--strat|--strate|--strateg|--strategy)
  94                case "$#,$1" in
  95                *,*=*)
  96                        strategy=`expr "z$1" : 'z-[^=]*=\(.*\)'` ;;
  97                1,*)
  98                        usage ;;
  99                *)
 100                        strategy="$2"
 101                        shift ;;
 102                esac
 103                strategy_args="${strategy_args}-s $strategy "
 104                ;;
 105        -X*)
 106                case "$#,$1" in
 107                1,-X)
 108                        usage ;;
 109                *,-X)
 110                        xx="-X $(git rev-parse --sq-quote "$2")"
 111                        shift ;;
 112                *,*)
 113                        xx=$(git rev-parse --sq-quote "$1") ;;
 114                esac
 115                merge_args="$merge_args$xx "
 116                ;;
 117        -r=*|--r=*|--re=*|--reb=*|--reba=*|--rebas=*|--rebase=*)
 118                rebase="${1#*=}"
 119                ;;
 120        -r|--r|--re|--reb|--reba|--rebas|--rebase)
 121                rebase=true
 122                ;;
 123        --no-r|--no-re|--no-reb|--no-reba|--no-rebas|--no-rebase)
 124                rebase=false
 125                ;;
 126        --recurse-submodules)
 127                recurse_submodules=--recurse-submodules
 128                ;;
 129        --recurse-submodules=*)
 130                recurse_submodules="$1"
 131                ;;
 132        --no-recurse-submodules)
 133                recurse_submodules=--no-recurse-submodules
 134                ;;
 135        --verify-signatures)
 136                verify_signatures=--verify-signatures
 137                ;;
 138        --no-verify-signatures)
 139                verify_signatures=--no-verify-signatures
 140                ;;
 141        --d|--dr|--dry|--dry-|--dry-r|--dry-ru|--dry-run)
 142                dry_run=--dry-run
 143                ;;
 144        -h|--help-all)
 145                usage
 146                ;;
 147        *)
 148                # Pass thru anything that may be meant for fetch.
 149                break
 150                ;;
 151        esac
 152        shift
 153done
 154
 155case "$rebase" in
 156preserve)
 157        rebase=true
 158        rebase_args=--preserve-merges
 159        ;;
 160true|false|'')
 161        ;;
 162*)
 163        echo "Invalid value for --rebase, should be true, false, or preserve"
 164        usage
 165        exit 1
 166        ;;
 167esac
 168
 169error_on_no_merge_candidates () {
 170        exec >&2
 171        for opt
 172        do
 173                case "$opt" in
 174                -t|--t|--ta|--tag|--tags)
 175                        echo "Fetching tags only, you probably meant:"
 176                        echo "  git fetch --tags"
 177                        exit 1
 178                esac
 179        done
 180
 181        if test true = "$rebase"
 182        then
 183                op_type=rebase
 184                op_prep=against
 185        else
 186                op_type=merge
 187                op_prep=with
 188        fi
 189
 190        upstream=$(git config "branch.$curr_branch_short.merge")
 191        remote=$(git config "branch.$curr_branch_short.remote")
 192
 193        if [ $# -gt 1 ]; then
 194                if [ "$rebase" = true ]; then
 195                        printf "There is no candidate for rebasing against "
 196                else
 197                        printf "There are no candidates for merging "
 198                fi
 199                echo "among the refs that you just fetched."
 200                echo "Generally this means that you provided a wildcard refspec which had no"
 201                echo "matches on the remote end."
 202        elif [ $# -gt 0 ] && [ "$1" != "$remote" ]; then
 203                echo "You asked to pull from the remote '$1', but did not specify"
 204                echo "a branch. Because this is not the default configured remote"
 205                echo "for your current branch, you must specify a branch on the command line."
 206        elif [ -z "$curr_branch" -o -z "$upstream" ]; then
 207                . git-parse-remote
 208                error_on_missing_default_upstream "pull" $op_type $op_prep \
 209                        "git pull <remote> <branch>"
 210        else
 211                echo "Your configuration specifies to $op_type $op_prep the ref '${upstream#refs/heads/}'"
 212                echo "from the remote, but no such ref was fetched."
 213        fi
 214        exit 1
 215}
 216
 217test true = "$rebase" && {
 218        if ! git rev-parse -q --verify HEAD >/dev/null
 219        then
 220                # On an unborn branch
 221                if test -f "$GIT_DIR/index"
 222                then
 223                        die "$(gettext "updating an unborn branch with changes added to the index")"
 224                fi
 225        else
 226                require_clean_work_tree "pull with rebase" "Please commit or stash them."
 227        fi
 228        oldremoteref= &&
 229        test -n "$curr_branch" &&
 230        . git-parse-remote &&
 231        remoteref="$(get_remote_merge_branch "$@" 2>/dev/null)" &&
 232        oldremoteref="$(git rev-parse -q --verify "$remoteref")" &&
 233        for reflog in $(git rev-list -g $remoteref 2>/dev/null)
 234        do
 235                if test "$reflog" = "$(git merge-base $reflog $curr_branch)"
 236                then
 237                        oldremoteref="$reflog"
 238                        break
 239                fi
 240        done
 241}
 242orig_head=$(git rev-parse -q --verify HEAD)
 243git fetch $verbosity $progress $dry_run $recurse_submodules --update-head-ok "$@" || exit 1
 244test -z "$dry_run" || exit 0
 245
 246curr_head=$(git rev-parse -q --verify HEAD)
 247if test -n "$orig_head" && test "$curr_head" != "$orig_head"
 248then
 249        # The fetch involved updating the current branch.
 250
 251        # The working tree and the index file is still based on the
 252        # $orig_head commit, but we are merging into $curr_head.
 253        # First update the working tree to match $curr_head.
 254
 255        eval_gettextln "Warning: fetch updated the current branch head.
 256Warning: fast-forwarding your working tree from
 257Warning: commit \$orig_head." >&2
 258        git update-index -q --refresh
 259        git read-tree -u -m "$orig_head" "$curr_head" ||
 260                die "$(eval_gettext "Cannot fast-forward your working tree.
 261After making sure that you saved anything precious from
 262$ git diff \$orig_head
 263output, run
 264$ git reset --hard
 265to recover.")"
 266
 267fi
 268
 269merge_head=$(sed -e '/  not-for-merge   /d' \
 270        -e 's/  .*//' "$GIT_DIR"/FETCH_HEAD | \
 271        tr '\012' ' ')
 272
 273case "$merge_head" in
 274'')
 275        error_on_no_merge_candidates "$@"
 276        ;;
 277?*' '?*)
 278        if test -z "$orig_head"
 279        then
 280                die "$(gettext "Cannot merge multiple branches into empty head")"
 281        fi
 282        if test true = "$rebase"
 283        then
 284                die "$(gettext "Cannot rebase onto multiple branches")"
 285        fi
 286        ;;
 287esac
 288
 289# Pulling into unborn branch: a shorthand for branching off
 290# FETCH_HEAD, for lazy typers.
 291if test -z "$orig_head"
 292then
 293        # Two-way merge: we claim the index is based on an empty tree,
 294        # and try to fast-forward to HEAD.  This ensures we will not
 295        # lose index/worktree changes that the user already made on
 296        # the unborn branch.
 297        empty_tree=4b825dc642cb6eb9a060e54bf8d69288fbee4904
 298        git read-tree -m -u $empty_tree $merge_head &&
 299        git update-ref -m "initial pull" HEAD $merge_head "$curr_head"
 300        exit
 301fi
 302
 303if test true = "$rebase"
 304then
 305        o=$(git show-branch --merge-base $curr_branch $merge_head $oldremoteref)
 306        if test "$oldremoteref" = "$o"
 307        then
 308                unset oldremoteref
 309        fi
 310fi
 311
 312merge_name=$(git fmt-merge-msg $log_arg <"$GIT_DIR/FETCH_HEAD") || exit
 313case "$rebase" in
 314true)
 315        eval="git-rebase $diffstat $strategy_args $merge_args $rebase_args $verbosity"
 316        eval="$eval --onto $merge_head ${oldremoteref:-$merge_head}"
 317        ;;
 318*)
 319        eval="git-merge $diffstat $no_commit $verify_signatures $edit $squash $no_ff $ff_only"
 320        eval="$eval  $log_arg $strategy_args $merge_args $verbosity $progress"
 321        eval="$eval \"\$merge_name\" HEAD $merge_head"
 322        ;;
 323esac
 324eval "exec $eval"