Merge branch 'maint'

[git.git] / Documentation / git-pull.txt

diff --git a/Documentation/git-pull.txt b/Documentation/git-pull.txt
index 77fdaf146eaa20327b0830ac69a6cc6b3e8f9797..3405ca09e85e9c81b9d48c753a2f117e7edca4eb 100644 (file)
--- a/Documentation/git-pull.txt
+++ b/Documentation/git-pull.txt
@@ -15,16 +15,37 @@ 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
 when merging local branches into the current branch.
 
+Also note that options meant for `git-pull` itself and underlying
+`git-merge` must be given before the options meant for `git-fetch`.
 
 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[]
@@ -33,16 +54,6 @@ include::urls-remotes.txt[]
 
 include::merge-strategies.txt[]
 
-\--rebase::
-       Instead of a merge, perform a rebase after fetching.
-       *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.
-
 DEFAULT BEHAVIOUR
 -----------------