Merge branch 'mm/maint-sort-config-doc' into mm/sort-config-doc

[git.git] / Documentation / git-describe.txt

diff --git a/Documentation/git-describe.txt b/Documentation/git-describe.txt
index 44b166888a00567d12f287416a6fa50135b36cfb..3d79f05995d28214f68640dd3f693033dff03547 100644 (file)
--- 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.
 
 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
 -------
 
 OPTIONS
 -------

-<committish>::
-       The object name of the committish.
+<committish>...::
+       Committish object names to describe.

 
 --all::
        Instead of using only the annotated tags, use any ref
 
 --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
 
 --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
 
 --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 <torvalds@osdl.org>, but somewhat
 Author
 ------
 Written by Linus Torvalds <torvalds@osdl.org>, but somewhat

-butchered by Junio C Hamano <junkio@cox.net>.  Later significantly
+butchered by Junio C Hamano <gitster@pobox.com>.  Later significantly

 updated by Shawn Pearce <spearce@spearce.org>.
 
 Documentation
 updated by Shawn Pearce <spearce@spearce.org>.
 
 Documentation