author | Junio C Hamano <gitster@pobox.com> | |
Sat, 24 Jan 2009 02:48:14 +0000 (18:48 -0800) | ||
committer | Junio C Hamano <gitster@pobox.com> | |
Sat, 24 Jan 2009 02:48:14 +0000 (18:48 -0800) |
* maint-1.6.0:
Fix Documentation for git-describe
Fix Documentation for git-describe
1 | 2 | |||
---|---|---|---|---|
Documentation/git-describe.txt | patch | | diff1 | | diff2 | | blob | history |
diff --combined Documentation/git-describe.txt
index 3d79f05995d28214f68640dd3f693033dff03547,59a6fd17ab3566986aa2f4b12b2ce034aa2c5a97..a30c5ac96618f5010388edd66815ec97971a92e0
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
-------
--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
Automatically implies --tags.
--abbrev=<n>::
- Instead of using the default 8 hexadecimal digits as the
+ Instead of using the default 7 hexadecimal digits as the
abbreviated object name, use <n> digits.
--candidates=<n>::