From: Junio C Hamano Date: Sat, 24 Jan 2009 02:48:14 +0000 (-0800) Subject: Merge branch 'maint-1.6.0' into maint X-Git-Tag: v1.6.1.1~10 X-Git-Url: https://git.lorimer.id.au/gitweb.git/diff_plain/b61971520738dbdc7ea2e46f8183dffe7fa4f48d?hp=-c Merge branch 'maint-1.6.0' into maint * maint-1.6.0: Fix Documentation for git-describe --- b61971520738dbdc7ea2e46f8183dffe7fa4f48d diff --combined Documentation/git-describe.txt index 3d79f05995,59a6fd17ab..a30c5ac966 --- a/Documentation/git-describe.txt +++ b/Documentation/git-describe.txt @@@ -18,9 -18,6 +18,9 @@@ shown. Otherwise, it suffixes the tag 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 ------- @@@ -29,13 -26,11 +29,13 @@@ --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 @@@ -43,7 -38,7 +43,7 @@@ Automatically implies --tags. --abbrev=:: - Instead of using the default 8 hexadecimal digits as the + Instead of using the default 7 hexadecimal digits as the abbreviated object name, use digits. --candidates=::