summaryrefslogtreecommitdiff
path: root/Documentation/git-pull.txt
diff options
context:
space:
mode:
authorJay Soffian <jaysoffian@gmail.com>2008-02-19 19:24:32 (GMT)
committerJunio C Hamano <gitster@pobox.com>2008-02-20 05:31:33 (GMT)
commita288394ed3f2ec1feea632ee28fb41d1ad2172bf (patch)
treec157105fd017dda485e6556bb79749e7d9f20eb0 /Documentation/git-pull.txt
parentafa9b620f9432491a453d752e8bf62860d7834c0 (diff)
downloadgit-a288394ed3f2ec1feea632ee28fb41d1ad2172bf.zip
git-a288394ed3f2ec1feea632ee28fb41d1ad2172bf.tar.gz
git-a288394ed3f2ec1feea632ee28fb41d1ad2172bf.tar.bz2
Correct git-pull documentation
The --rebase option was documented in the wrong place (under MERGE STRATEGIES instead of OPTIONS). Noted the branch.<name>.rebase option. Signed-off-by: Jay Soffian <jaysoffian@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-pull.txt')
-rw-r--r--Documentation/git-pull.txt20
1 files changed, 12 insertions, 8 deletions
diff --git a/Documentation/git-pull.txt b/Documentation/git-pull.txt
index 179bdfc..7378943 100644
--- a/Documentation/git-pull.txt
+++ b/Documentation/git-pull.txt
@@ -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
@@ -26,19 +27,14 @@ OPTIONS
include::merge-options.txt[]
:git-pull: 1
-include::fetch-options.txt[]
-
-include::pull-fetch-param.txt[]
-
-include::urls-remotes.txt[]
-
-include::merge-strategies.txt[]
\--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 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
@@ -48,6 +44,14 @@ unless you have read linkgit:git-rebase[1] carefully.
\--no-rebase::
Override earlier \--rebase.
+include::fetch-options.txt[]
+
+include::pull-fetch-param.txt[]
+
+include::urls-remotes.txt[]
+
+include::merge-strategies.txt[]
+
DEFAULT BEHAVIOUR
-----------------