api-run-command.txt: talk about run_hook()

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

diff --git a/Documentation/git-describe.txt b/Documentation/git-describe.txt
index c4dbc2ae342833561080f7a18a93bcf5ac5a0dd3..a99b4ef9434f11d46cecbd80cca9548866c1aa48 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.
 
+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
 -------
@@ -26,11 +29,13 @@ OPTIONS
 
 --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
@@ -82,7 +87,7 @@ With something like git.git current tree, I get:
        v1.0.4-14-g2414721
 
 i.e. the current head of my "parent" branch is based on v1.0.4,
-but since it has a handful commits on top of that,
+but since it has a few commits on top of that,
 describe has added the number of additional commits ("14") and
 an abbreviated object name for the commit itself ("2414721")
 at the end.