[PATCH v2] Docs: Clarify the --tags option of `git fetch'
On Wed, 21 Sep 2011 21:00:51 -0700, Junio C Hamano wrote:
Show 13 quoted lines
> Michael Witten <mfwitten@gmail.com> writes:
>
>> That is,
>>
>> git fetch origin frotz --tags
>>
>> is equivalent to:
>>
>> git fetch origin frotz 'refs/tags/*:refs/tags/*'
>
> No matter what you do, please do not introduce a bad example that violates
> the usual command line syntax convention to have subcommand (e.g. fetch),
> options meant for the subcommand (e.g. --tags) and then other arguments.
Too bad; I think it really supplements the description well.
In any case:
* The example has been changed as per your wish.
* `short-hand' has been changed to `shorthand'.
* Trailing whitespace has been removed from a line.
8<-----------8<-----------8<-----------8<-----------8<-----------8<-----------
See the discussion starting here:
[PATCH] Clarify that '--tags' fetches tags only
Message-ID: <1314997486-29996-1-git-send-email-anatol.pomozov@gmail.com>
http://thread.gmane.org/gmane.comp.version-control.git/180636
Suggested-by: Anatol Pomozov <anatol.pomozov@gmail.com>
Signed-off-by: Michael Witten <mfwitten@gmail.com>
---
Documentation/fetch-options.txt | 21 ++++++++++++++++++---
1 files changed, 18 insertions(+), 3 deletions(-)
diff --git a/Documentation/fetch-options.txt b/Documentation/fetch-options.txt
index 39d326a..da594bd 100644
--- a/Documentation/fetch-options.txt
+++ b/Documentation/fetch-options.txt
@@ -61,9 +61,24 @@ ifndef::git-pull[]
objects reachable from the branch heads that are being
tracked will not be fetched by this mechanism. This
flag lets all tags and their associated objects be
- downloaded. The default behavior for a remote may be
- specified with the remote.<name>.tagopt setting. See
- linkgit:git-config[1].
+ downloaded.
++
+This option is merely a shorthand for writing the
+refspec `refs/tags/\*:refs/tags/\*'; consequently,
+using this option overrides any default refspec that
+would be used if no refspec were provided on the
+command line. That is,
++
+ git fetch origin --tags
+ git fetch origin --tags frotz
++
+are equivalent to:
++
+ git fetch origin 'refs/tags/*:refs/tags/*'
+ git fetch origin 'refs/tags/*:refs/tags/*' frotz
++
+The default behavior for a remote may be specified with
+the remote.<name>.tagopt setting. See linkgit:git-config[1].
--recurse-submodules[=yes|on-demand|no]::
This option controls if and under what conditions new commits of
--
1.7.6.409.ge7a85
Michael Witten <mfwitten@gmail.com>