Skip to content

Commit 5328456

Browse files
committed
fetch doc: update introductory part for clarity
- "Branches" is a more common way to say "heads" in these days. - Remote-tracking branches are used a lot more these days and it is worth mentioning that it is one of the primary side effects of the command to update them. - Avoid "X. That means Y." If Y is easier to understand to readers, just say that upfront. - Use of explicit refspec to fetch tags does not have much to do with turning "auto following" on or off. It is a way to fetch tags that otherwise would not be fetched by auto-following. Helped-by: Marc Branchaud <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent e156455 commit 5328456

File tree

1 file changed

+13
-11
lines changed

1 file changed

+13
-11
lines changed

Documentation/git-fetch.txt

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -17,20 +17,22 @@ SYNOPSIS
1717

1818
DESCRIPTION
1919
-----------
20-
Fetches named heads or tags from one or more other repositories,
21-
along with the objects necessary to complete them.
20+
Fetch branches and/or tags (collectively, "refs") from one or more
21+
other repositories, along with the objects necessary to complete
22+
their histories.
2223

23-
The ref names and their object names of fetched refs are stored
24-
in `.git/FETCH_HEAD`. This information is left for a later merge
25-
operation done by 'git merge'.
24+
The names of refs that are fetched, together with the object names
25+
they point at, are written to `.git/FETCH_HEAD`. This information
26+
can be used to learn what was fetched. In addition, the remote-tracking
27+
branches are updated (see description on <refspec> below for details).
2628

27-
By default, tags are auto-followed. This means that when fetching
28-
from a remote, any tags on the remote that point to objects that exist
29-
in the local repository are fetched. The effect is to fetch tags that
29+
By default, any tag that points into the histories being fetched is
30+
also fetched; the effect is to fetch tags that
3031
point at branches that you are interested in. This default behavior
31-
can be changed by using the --tags or --no-tags options, by
32-
configuring remote.<name>.tagopt, or by using a refspec that fetches
33-
tags explicitly.
32+
can be changed by using the --tags or --no-tags options or by
33+
configuring remote.<name>.tagopt. By using a refspec that fetches tags
34+
explicitly, you can fetch tags that do not point into branches you
35+
are interested in as well.
3436

3537
'git fetch' can fetch from either a single named repository,
3638
or from several repositories at once if <group> is given and

0 commit comments

Comments
 (0)