diff options
| author | Junio C Hamano <gitster@pobox.com> | 2008-10-19 16:06:39 -0700 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2008-10-19 16:06:39 -0700 |
| commit | 18e143487ddb5b32b2f6003972d2115bb4ac460f (patch) | |
| tree | 91900030326713c669a00f2bcadc6aaec948efda /Documentation | |
| parent | edacb101ef831cdc59d07015b1b5cd1aaddcc588 (diff) | |
| parent | 7e425c4fbbe9affffa822f154d8bb2d0da6699ef (diff) | |
| download | git-18e143487ddb5b32b2f6003972d2115bb4ac460f.tar.gz git-18e143487ddb5b32b2f6003972d2115bb4ac460f.tar.xz | |
Merge branch 'sp/describe-lwtag'
* sp/describe-lwtag:
describe: Make --tags and --all match lightweight tags more often
Diffstat (limited to 'Documentation')
| -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 c4dbc2ae3..3d79f0599 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 |