Skip to content

Commit

Permalink
Documentation: git-fetch/pull updates.
Browse files Browse the repository at this point in the history
We do not accept multiple <refspecs> on one Pull:/Push: line
right now (we could lift this tentative workaround for the
broken refnames), but we have always accepted multiple such
lines, so use that form in the examples and discussion.

Also explicitly mention that Octopus is made only with an
explicit command line request and never from Pull: lines.

Add a couple of cross references.

Signed-off-by: Junio C Hamano <junkio@cox.net>
  • Loading branch information
Junio C Hamano committed Nov 5, 2005
1 parent bccf595 commit fdd0897
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 4 deletions.
5 changes: 5 additions & 0 deletions Documentation/git-fetch.txt
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,11 @@ include::pull-fetch-param.txt[]
update the index and working directory, so use it with care.


SEE ALSO
--------
gitlink:git-pull[1]


Author
------
Written by Linus Torvalds <torvalds@osdl.org> and
Expand Down
2 changes: 1 addition & 1 deletion Documentation/git-merge.txt
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ include::merge-pull-opts.txt[]

SEE ALSO
--------
gitlink:git-fmt-merge-msg[1]
gitlink:git-fmt-merge-msg[1], gitlink:git-pull[1]


Author
Expand Down
5 changes: 5 additions & 0 deletions Documentation/git-pull.txt
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,11 @@ merge the remote `origin` head into the current,
local `master` branch.


SEE ALSO
--------
gitlink:git-fetch[1], gitlink:git-merge[1]


Author
------
Written by Linus Torvalds <torvalds@osdl.org>
Expand Down
22 changes: 19 additions & 3 deletions Documentation/pull-fetch-param.txt
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@ file in `$GIT_DIR/remotes` directory can be given; the
named file should be in the following format:
+
URL: one of the above URL format
Push: <refspec>...
Pull: <refspec>...
Push: <refspec>
Pull: <refspec>
+
When such a short-hand is specified in place of
<repository> without <refspec> parameters on the command
line, <refspec>... specified on `Push:` lines or `Pull:`
line, <refspec> specified on `Push:` lines or `Pull:`
lines are used for `git-push` and `git-fetch`/`git-pull`,
respectively. Multiple `Push:` and and `Pull:` lines may
be specified for additional branch mappings.
Expand Down Expand Up @@ -91,6 +91,22 @@ remote `master` branch to a local `origin` branch, which
is then merged to a local development branch, again typically
named `master`.
+
[NOTE]
There is a difference between listing multiple <refspec>
directly on `git-pull` command line and having multiple
`Pull:` <refspec> lines for a <repository> and running
`git-pull` command without any explicit <refspec> parameters.
<refspec> listed explicitly on the command line are always
merged into the current branch after fetching. In other words,
if you list more than one remote refs, you would be making
an Octopus. While `git-pull` run without any explicit <refspec>
parameter takes default <refspec>s from `Pull:` lines, it
merges only the first <refspec> found into the current branch,
after fetching all the remote refs. This is because making an
Octopus from remote refs is rarely done, while keeping track
of multiple remote heads in one-go by fetching more than one
is often useful.
+
Some short-cut notations are also supported.
+
* For backward compatibility, `tag` is almost ignored;
Expand Down

0 comments on commit fdd0897

Please sign in to comment.