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