Skip to content

Commit

Permalink
fetch doc: remove "short-cut" section
Browse files Browse the repository at this point in the history
It is misleading to mention that <ref> that does not store is to
fetch the ref into FETCH_HEAD, because a refspec that does store is
also to fetch the LHS into FETCH_HEAD.  It is doubly misleading to
list it as part of "short-cut".  <ref> stands for a refspec that has
it on the LHS with a colon and an empty RHS, and that definition
should be given at the beginning of the entry where the format is
defined.

Tentatively remove this misleading description, which leaves the
`tag <tag>` as the only true short-hand, so move it at the beginning
of the entry.

Signed-off-by: Junio C Hamano <gitster@pobox.com>
  • Loading branch information
Junio C Hamano committed Jun 4, 2014
1 parent b8bdaa9 commit 5cc3268
Showing 1 changed file with 3 additions and 13 deletions.
16 changes: 3 additions & 13 deletions Documentation/pull-fetch-param.txt
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ endif::git-pull[]
by a colon `:`, followed by the destination ref <dst>.
The colon can be omitted when <dst> is empty.
+
`tag <tag>` means the same as `refs/tags/<tag>:refs/tags/<tag>`;
it requests fetching everything up to the given tag.
+
The remote ref that matches <src>
is fetched, and if <dst> is not empty string, the local
ref that matches it is fast-forwarded using <src>.
Expand Down Expand Up @@ -56,16 +59,3 @@ 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.
endif::git-pull[]
+
Some short-cut notations are also supported.
+
* `tag <tag>` means the same as `refs/tags/<tag>:refs/tags/<tag>`;
it requests fetching everything up to the given tag.
ifndef::git-pull[]
* A parameter <ref> without a colon fetches that ref into FETCH_HEAD,
endif::git-pull[]
ifdef::git-pull[]
* A parameter <ref> without a colon merges <ref> into the current
branch,
endif::git-pull[]
and updates the remote-tracking branches (if any).

0 comments on commit 5cc3268

Please sign in to comment.