X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=Documentation%2Fgit-describe.txt;h=3d79f05995d28214f68640dd3f693033dff03547;hb=adcb2e0f466aa39cc5f15d5a76d1151f6c47daf2;hp=44b166888a00567d12f287416a6fa50135b36cfb;hpb=bb293b831b9d0aade79c0acf5bf6091106e7d19b;p=git.git diff --git a/Documentation/git-describe.txt b/Documentation/git-describe.txt index 44b166888..3d79f0599 100644 --- a/Documentation/git-describe.txt +++ b/Documentation/git-describe.txt @@ -18,19 +18,24 @@ 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 ------- -:: - The object name of the committish. +...:: + Committish object names to describe. --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 @@ -136,7 +141,7 @@ will be the smallest number of commits possible. Author ------ Written by Linus Torvalds , but somewhat -butchered by Junio C Hamano . Later significantly +butchered by Junio C Hamano . Later significantly updated by Shawn Pearce . Documentation