Documentation/git-pull.txt

   1 git-pull(1)
   2 ===========
   3
   4 NAME
   5 ----
   6 git-pull - Fetch from and merge with another repository or a local branch
   7
   8
   9 SYNOPSIS
  10 --------
  11 'git pull' [options] [<repository> [<refspec>...]]
  12
  13
  14 DESCRIPTION
  15 -----------
  16
  17 Incorporates changes from a remote repository into the current
  18 branch.  In its default mode, `git pull` is shorthand for
  19 `git fetch` followed by `git merge FETCH_HEAD`.
  20
  21 More precisely, 'git pull' runs 'git fetch' with the given
  22 parameters and calls 'git merge' to merge the retrieved branch
  23 heads into the current branch.
  24 With `--rebase`, it runs 'git rebase' instead of 'git merge'.
  25
  26 <repository> should be the name of a remote repository as
  27 passed to linkgit:git-fetch[1].  <refspec> can name an
  28 arbitrary remote ref (for example, the name of a tag) or even
  29 a collection of refs with corresponding remote tracking branches
  30 (e.g., refs/heads/*:refs/remotes/origin/*), but usually it is
  31 the name of a branch in the remote repository.
  32
  33 Default values for <repository> and <branch> are read from the
  34 "remote" and "merge" configuration for the current branch
  35 as set by linkgit:git-branch[1] `--track`.
  36
  37 Assume the following history exists and the current branch is
  38 "`master`":
  39
  40 ------------
  41           A---B---C master on origin
  42          /
  43     D---E---F---G master
  44 ------------
  45
  46 Then "`git pull`" will fetch and replay the changes from the remote
  47 `master` branch since it diverged from the local `master` (i.e., `E`)
  48 until its current commit (`C`) on top of `master` and record the
  49 result in a new commit along with the names of the two parent commits
  50 and a log message from the user describing the changes.
  51
  52 ------------
  53           A---B---C remotes/origin/master
  54          /         \
  55     D---E---F---G---H master
  56 ------------
  57
  58 See linkgit:git-merge[1] for details, including how conflicts
  59 are presented and handled.
  60
  61 In git 1.7.0 or later, to cancel a conflicting merge, use
  62 `git reset --merge`.  *Warning*: In older versions of git, running 'git pull'
  63 with uncommitted changes is discouraged: while possible, it leaves you
  64 in a state that may be hard to back out of in the case of a conflict.
  65
  66 If any of the remote changes overlap with local uncommitted changes,
  67 the merge will be automatically cancelled and the work tree untouched.
  68 It is generally best to get any local changes in working order before
  69 pulling or stash them away with linkgit:git-stash[1].
  70
  71 OPTIONS
  72 -------
  73
  74 Options meant for 'git pull' itself and the underlying 'git merge'
  75 must be given before the options meant for 'git fetch'.
  76
  77 -q::
  78 --quiet::
  79         This is passed to both underlying git-fetch to squelch reporting of
  80         during transfer, and underlying git-merge to squelch output during
  81         merging.
  82
  83 -v::
  84 --verbose::
  85         Pass --verbose to git-fetch and git-merge.
  86
  87 Options related to merging
  88 ~~~~~~~~~~~~~~~~~~~~~~~~~~
  89
  90 include::merge-options.txt[]
  91
  92 :git-pull: 1
  93
  94 --rebase::
  95         Instead of a merge, perform a rebase after fetching.  If
  96         there is a remote ref for the upstream branch, and this branch
  97         was rebased since last fetched, the rebase uses that information
  98         to avoid rebasing non-local changes. To make this the default
  99         for branch `<name>`, set configuration `branch.<name>.rebase`
 100         to `true`.
 101 +
 102 [NOTE]
 103 This is a potentially _dangerous_ mode of operation.
 104 It rewrites history, which does not bode well when you
 105 published that history already.  Do *not* use this option
 106 unless you have read linkgit:git-rebase[1] carefully.
 107
 108 --no-rebase::
 109         Override earlier --rebase.
 110
 111 Options related to fetching
 112 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 113
 114 include::fetch-options.txt[]
 115
 116 include::pull-fetch-param.txt[]
 117
 118 include::urls-remotes.txt[]
 119
 120 include::merge-strategies.txt[]
 121
 122 DEFAULT BEHAVIOUR
 123 -----------------
 124
 125 Often people use `git pull` without giving any parameter.
 126 Traditionally, this has been equivalent to saying `git pull
 127 origin`.  However, when configuration `branch.<name>.remote` is
 128 present while on branch `<name>`, that value is used instead of
 129 `origin`.
 130
 131 In order to determine what URL to use to fetch from, the value
 132 of the configuration `remote.<origin>.url` is consulted
 133 and if there is not any such variable, the value on `URL: ` line
 134 in `$GIT_DIR/remotes/<origin>` file is used.
 135
 136 In order to determine what remote branches to fetch (and
 137 optionally store in the tracking branches) when the command is
 138 run without any refspec parameters on the command line, values
 139 of the configuration variable `remote.<origin>.fetch` are
 140 consulted, and if there aren't any, `$GIT_DIR/remotes/<origin>`
 141 file is consulted and its `Pull: ` lines are used.
 142 In addition to the refspec formats described in the OPTIONS
 143 section, you can have a globbing refspec that looks like this:
 144
 145 ------------
 146 refs/heads/*:refs/remotes/origin/*
 147 ------------
 148
 149 A globbing refspec must have a non-empty RHS (i.e. must store
 150 what were fetched in tracking branches), and its LHS and RHS
 151 must end with `/*`.  The above specifies that all remote
 152 branches are tracked using tracking branches in
 153 `refs/remotes/origin/` hierarchy under the same name.
 154
 155 The rule to determine which remote branch to merge after
 156 fetching is a bit involved, in order not to break backward
 157 compatibility.
 158
 159 If explicit refspecs were given on the command
 160 line of `git pull`, they are all merged.
 161
 162 When no refspec was given on the command line, then `git pull`
 163 uses the refspec from the configuration or
 164 `$GIT_DIR/remotes/<origin>`.  In such cases, the following
 165 rules apply:
 166
 167 . If `branch.<name>.merge` configuration for the current
 168   branch `<name>` exists, that is the name of the branch at the
 169   remote site that is merged.
 170
 171 . If the refspec is a globbing one, nothing is merged.
 172
 173 . Otherwise the remote branch of the first refspec is merged.
 174
 175
 176 EXAMPLES
 177 --------
 178
 179 * Update the remote-tracking branches for the repository
 180   you cloned from, then merge one of them into your
 181   current branch:
 182 +
 183 ------------------------------------------------
 184 $ git pull, git pull origin
 185 ------------------------------------------------
 186 +
 187 Normally the branch merged in is the HEAD of the remote repository,
 188 but the choice is determined by the branch.<name>.remote and
 189 branch.<name>.merge options; see linkgit:git-config[1] for details.
 190
 191 * Merge into the current branch the remote branch `next`:
 192 +
 193 ------------------------------------------------
 194 $ git pull origin next
 195 ------------------------------------------------
 196 +
 197 This leaves a copy of `next` temporarily in FETCH_HEAD, but
 198 does not update any remote-tracking branches. Using remote-tracking
 199 branches, the same can be done by invoking fetch and merge:
 200 +
 201 ------------------------------------------------
 202 $ git fetch origin
 203 $ git merge origin/next
 204 ------------------------------------------------
 205
 206
 207 If you tried a pull which resulted in a complex conflicts and
 208 would want to start over, you can recover with 'git reset'.
 209
 210
 211 SEE ALSO
 212 --------
 213 linkgit:git-fetch[1], linkgit:git-merge[1], linkgit:git-config[1]
 214
 215
 216 Author
 217 ------
 218 Written by Linus Torvalds <torvalds@osdl.org>
 219 and Junio C Hamano <gitster@pobox.com>
 220
 221 Documentation
 222 --------------
 223 Documentation by Jon Loeliger,
 224 David Greaves,
 225 Junio C Hamano and the git-list <git@vger.kernel.org>.
 226
 227 GIT
 228 ---
 229 Part of the linkgit:git[1] suite