From: Jay Soffian Date: Tue, 19 Feb 2008 19:24:32 +0000 (-0500) Subject: Correct git-pull documentation X-Git-Tag: v1.5.5-rc0~189 X-Git-Url: https://git.tokkee.org/?a=commitdiff_plain;h=a288394ed3f2ec1feea632ee28fb41d1ad2172bf;p=git.git Correct git-pull documentation The --rebase option was documented in the wrong place (under MERGE STRATEGIES instead of OPTIONS). Noted the branch..rebase option. Signed-off-by: Jay Soffian Signed-off-by: Junio C Hamano --- diff --git a/Documentation/git-pull.txt b/Documentation/git-pull.txt index 179bdfc69..737894390 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 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 ``, set configuration `branch..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 -----------------