git-p4: Clean up git-p4 submit's log message handling.
[gitweb.git] / Documentation / git-pull.txt
index e1eb2c1d0037f06dbf2b5cc0bde84918157ee2bf..737894390d8033bf470b3bfe3aeade858f38717e 100644 (file)
@@ -15,6 +15,7 @@ DESCRIPTION
 -----------
 Runs `git-fetch` with the given parameters, and calls `git-merge`
 to merge the retrieved head(s) into the current branch.
+With `--rebase`, calls `git-rebase` instead of `git-merge`.
 
 Note that you can use `.` (current directory) as the
 <repository> to pull from the local repository -- this is useful
@@ -25,6 +26,24 @@ OPTIONS
 -------
 include::merge-options.txt[]
 
+:git-pull: 1
+
+\--rebase::
+       Instead of a merge, perform a rebase after fetching.  If
+       there is a remote ref for the upstream branch, and this branch
+       was rebased since last fetched, the rebase uses that information
+       to avoid rebasing non-local changes. To make this the default
+       for branch `<name>`, set configuration `branch.<name>.rebase`
+       to `true`.
++
+*NOTE:* This is a potentially _dangerous_ mode of operation.
+It rewrites history, which does not bode well when you
+published that history already.  Do *not* use this option
+unless you have read linkgit:git-rebase[1] carefully.
+
+\--no-rebase::
+       Override earlier \--rebase.
+
 include::fetch-options.txt[]
 
 include::pull-fetch-param.txt[]
@@ -96,7 +115,7 @@ git pull, git pull origin::
        current branch.  Normally the branch merged in is
        the HEAD of the remote repository, but the choice is
        determined by the branch.<name>.remote and
-       branch.<name>.merge options; see gitlink:git-config[1]
+       branch.<name>.merge options; see linkgit:git-config[1]
        for details.
 
 git pull origin next::
@@ -143,12 +162,12 @@ The final command then merges the newly fetched `tmp` into master.
 
 If you tried a pull which resulted in a complex conflicts and
 would want to start over, you can recover with
-gitlink:git-reset[1].
+linkgit:git-reset[1].
 
 
 SEE ALSO
 --------
-gitlink:git-fetch[1], gitlink:git-merge[1], gitlink:git-config[1]
+linkgit:git-fetch[1], linkgit:git-merge[1], linkgit:git-config[1]
 
 
 Author
@@ -164,4 +183,4 @@ Junio C Hamano and the git-list <git@vger.kernel.org>.
 
 GIT
 ---
-Part of the gitlink:git[7] suite
+Part of the linkgit:git[7] suite