GIT 1.6.1.3

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

diff --git a/Documentation/git-describe.txt b/Documentation/git-describe.txt
index c4dbc2ae342833561080f7a18a93bcf5ac5a0dd3..a30c5ac96618f5010388edd66815ec97971a92e0 100644 (file)
--- a/Documentation/git-describe.txt
+++ b/Documentation/git-describe.txt
@@ -18,6 +18,9 @@ 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
 -------


@@ -26,11 +29,13 @@ OPTIONS
 
 --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


@@ -38,7 +43,7 @@ OPTIONS
        Automatically implies --tags.
 
 --abbrev=<n>::
        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>::
        abbreviated object name, use <n> digits.
 
 --candidates=<n>::