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>
Jay Soffian committed
Feb 19, 2008 at 14:24 UTC
a288394ed3f2ec1feea632ee28fb41d1ad2172bf
1 file changed
+12
-8
Documentation/git-pull.txt
+12
-8
@@ -15,6 +15,7 @@ DESCRIPTION
15
-----------
16
Runs `git-fetch` with the given parameters, and calls `git-merge`
17
to merge the retrieved head(s) into the current branch.
18
+With `--rebase`, calls `git-rebase` instead of `git-merge`.
19
20
Note that you can use `.` (current directory) as the
21
<repository> to pull from the local repository -- this is useful
@@ -26,19 +27,14 @@ OPTIONS
27
include::merge-options.txt[]
28
29
:git-pull: 1
29
-include::fetch-options.txt[]
30
-
31
-include::pull-fetch-param.txt[]
32
-
33
-include::urls-remotes.txt[]
34
-
35
-include::merge-strategies.txt[]
30
31
\--rebase::
32
Instead of a merge, perform a rebase after fetching. If
33
there is a remote ref for the upstream branch, and this branch
34
was rebased since last fetched, the rebase uses that information
41
- to avoid rebasing non-local changes.
35
+ to avoid rebasing non-local changes. To make this the default
36
+ for branch `<name>`, set configuration `branch.<name>.rebase`
37
+ to `true`.
38
+
39
*NOTE:* This is a potentially _dangerous_ mode of operation.
40
It rewrites history, which does not bode well when you
@@ -48,6 +44,14 @@ unless you have read linkgit:git-rebase[1] carefully.
44
\--no-rebase::
45
Override earlier \--rebase.
46
47
+include::fetch-options.txt[]
48
+
49
+include::pull-fetch-param.txt[]
50
+
51
+include::urls-remotes.txt[]
52
+
53
+include::merge-strategies.txt[]
54
+
55
DEFAULT BEHAVIOUR
56
-----------------
57