diff options
| author | Shawn O. Pearce <spearce@spearce.org> | 2008-10-13 07:39:46 -0700 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2008-10-17 11:35:43 -0700 |
| commit | 7e425c4fbbe9affffa822f154d8bb2d0da6699ef (patch) | |
| tree | 1dc1da95ff2740e01d0dc69ef471f6855ae866fa /Documentation/git-describe.txt | |
| parent | 5c283eb13c94be6ca974aa722159dc9838d10d97 (diff) | |
| download | git-7e425c4fbbe9affffa822f154d8bb2d0da6699ef.tar.gz | |
describe: Make --tags and --all match lightweight tags more often
If the caller supplies --tags they want the lightweight, unannotated
tags to be searched for a match. If a lightweight tag is closer
in the history, it should be matched, even if an annotated tag is
reachable further back in the commit chain.
The same applies with --all when matching any other type of ref.
Signed-off-by: Shawn O. Pearce <spearce@spearce.org>
Acked-By: Uwe Kleine-König <ukleinek@strlen.de>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-describe.txt')
| -rw-r--r-- | Documentation/git-describe.txt | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/Documentation/git-describe.txt b/Documentation/git-describe.txt index c4dbc2ae34..3d79f05995 100644 --- a/Documentation/git-describe.txt +++ b/Documentation/git-describe.txt @@ -18,6 +18,9 @@ shown. Otherwise, it suffixes the tag name with the number of additional commits on top of the tagged object and the abbreviated object name of the most recent commit. +By default (without --all or --tags) `git describe` only shows +annotated tags. For more information about creating annotated tags +see the -a and -s options to linkgit:git-tag[1]. OPTIONS ------- @@ -26,11 +29,13 @@ OPTIONS --all:: Instead of using only the annotated tags, use any ref - found in `.git/refs/`. + found in `.git/refs/`. This option enables matching + any known branch, remote branch, or lightweight tag. --tags:: Instead of using only the annotated tags, use any tag - found in `.git/refs/tags`. + found in `.git/refs/tags`. This option enables matching + a lightweight (non-annotated) tag. --contains:: Instead of finding the tag that predates the commit, find |