From: Junio C Hamano Date: Wed, 14 May 2008 20:46:42 +0000 (-0700) Subject: Merge branch 'maint-1.5.4' into maint X-Git-Tag: v1.5.5.2~6 X-Git-Url: https://git.lorimer.id.au/gitweb.git/diff_plain/a473445ac256f4a6ca5c66f83f33b85eec0e0c48?hp=-c Merge branch 'maint-1.5.4' into maint * maint-1.5.4: Documentation/git-describe.txt: make description more readable --- a473445ac256f4a6ca5c66f83f33b85eec0e0c48 diff --combined Documentation/git-describe.txt index d9aa2f2980,5e88b6e79a..69e1ab750d --- a/Documentation/git-describe.txt +++ b/Documentation/git-describe.txt @@@ -13,9 -13,10 +13,10 @@@ SYNOPSI DESCRIPTION ----------- The command finds the most recent tag that is reachable from a - commit, and if the commit itself is pointed at by the tag, shows - the tag. Otherwise, it suffixes the tag name with the number of - additional commits and the abbreviated object name of the commit. + commit. If the tag points to the commit, then only the tag is + 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. OPTIONS @@@ -45,30 -46,12 +46,30 @@@ candidates to describe the input committish consider up to candidates. Increasing above 10 will take slightly longer but may produce a more accurate result. + An of 0 will cause only exact matches to be output. + +--exact-match:: + Only output exact matches (a tag directly references the + supplied commit). This is a synonym for --candidates=0. --debug:: Verbosely display information about the searching strategy being employed to standard error. The tag name will still be printed to standard out. +--long:: + Always output the long format (the tag, the number of commits + and the abbreviated commit name) even when it matches a tag. + This is useful when you want to see parts of the commit object name + in "describe" output, even when the commit in question happens to be + a tagged version. Instead of just emitting the tag name, it will + describe such a commit as v1.2-0-deadbeef (0th commit since tag v1.2 + that points at object deadbeef....). + +--match :: + Only consider tags matching the given pattern (can be used to avoid + leaking private tags made from the repository). + EXAMPLES --------