From: Jay Soffian <jaysoffian@gmail.com>
To: git@vger.kernel.org
Cc: Jay Soffian <jaysoffian@gmail.com>
Subject: [PATCH] Correct git-pull documentation
Date: Fri, 15 Feb 2008 23:50:41 -0500 [thread overview]
Message-ID: <1203137441-52448-1-git-send-email-jaysoffian@gmail.com> (raw)
The --rebase option was documented in the wrong place (under MERGE
STRATEGIES instead of OPTIONS). Noted the branch.<name>.rebase
option and clarified the use '.' in a few places. Switched
"git-<command>" to "git command".
Signed-off-by: Jay Soffian <jaysoffian@gmail.com>
---
Documentation/git-pull.txt | 38 ++++++++++++++++++++++----------------
1 files changed, 22 insertions(+), 16 deletions(-)
diff --git a/Documentation/git-pull.txt b/Documentation/git-pull.txt
index 179bdfc..f734f18 100644
--- a/Documentation/git-pull.txt
+++ b/Documentation/git-pull.txt
@@ -8,13 +8,14 @@ git-pull - Fetch from and merge with another repository or a local branch
SYNOPSIS
--------
-'git-pull' <options> <repository> <refspec>...
+'git-pull' [<options>] [<repository>] [<refspec>...]
DESCRIPTION
-----------
-Runs `git-fetch` with the given parameters, and calls `git-merge`
-to merge the retrieved head(s) into the current branch.
+Runs `git fetch` with the given parameters, and calls `git merge` or
+`git rebase` to merge or rebase the retrieved head(s) into the
+current branch.
Note that you can use `.` (current directory) as the
<repository> to pull from the local repository -- this is useful
@@ -28,17 +29,12 @@ 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. This if the default if
+ `branch.<name>.rebase` is set.
+
*NOTE:* This is a potentially _dangerous_ mode of operation.
It rewrites history, which does not bode well when you
@@ -48,6 +44,12 @@ unless you have read linkgit:git-rebase[1] carefully.
\--no-rebase::
Override earlier \--rebase.
+include::pull-fetch-param.txt[]
+
+include::urls-remotes.txt[]
+
+include::merge-strategies.txt[]
+
DEFAULT BEHAVIOUR
-----------------
@@ -55,12 +57,13 @@ Often people use `git pull` without giving any parameter.
Traditionally, this has been equivalent to saying `git pull
origin`. However, when configuration `branch.<name>.remote` is
present while on branch `<name>`, that value is used instead of
-`origin`.
+`origin`. (`branch.<name>.remote` may be set to `.` to pull from
+the local repository by default.)
-In order to determine what URL to use to fetch from, the value
-of the configuration `remote.<origin>.url` is consulted
-and if there is not any such variable, the value on `URL: ` line
-in `$GIT_DIR/remotes/<origin>` file is used.
+Unless pulling from the local repository, a URL must be determined
+for the origin. This is done by first consulting
+`remote.<origin>.url`. If there is not any such variable, the value
+on `URL: ` line in `$GIT_DIR/remotes/<origin>` file is used.
In order to determine what remote branches to fetch (and
optionally store in the tracking branches) when the command is
@@ -138,6 +141,9 @@ You should refrain from abusing this option to sneak substantial
changes into a merge commit. Small fixups like bumping
release/version name would be acceptable.
+git pull --rebase . master::
+ This syntax is equivalent to calling `git rebase master`; see
+ linkgit:git-rebase[1] for details.
Command line pull of multiple branches from one repository::
+
------------------------------------------------
@@ -163,7 +169,7 @@ linkgit:git-reset[1].
SEE ALSO
--------
-linkgit:git-fetch[1], linkgit:git-merge[1], linkgit:git-config[1]
+linkgit:git-fetch[1], linkgit:git-merge[1], linkgit:git-config[1], linkgit:git-rebase[1]
Author
--
1.5.4.1.1281.g75df
next reply other threads:[~2008-02-16 4:51 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2008-02-16 4:50 Jay Soffian [this message]
2008-02-16 8:20 ` [PATCH] Correct git-pull documentation Nagy Balázs
2008-02-16 9:31 ` Junio C Hamano
2008-02-16 10:04 ` Jay Soffian
-- strict thread matches above, loose matches on Subject: below --
2008-02-19 19:24 Jay Soffian
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1203137441-52448-1-git-send-email-jaysoffian@gmail.com \
--to=jaysoffian@gmail.com \
--cc=git@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.