summaryrefslogtreecommitdiffstats
path: root/git-describe.txt
diff options
context:
space:
mode:
authorJunio C Hamano <junio@hera.kernel.org>2008-10-20 05:42:33 +0000
committerJunio C Hamano <junio@hera.kernel.org>2008-10-20 05:42:33 +0000
commit7d06a8aba96d4197610b089a0862b46d84a36f53 (patch)
tree32010c51081107cd4c7b54fb59b212abdd429fcd /git-describe.txt
parenta2deec5920d1cc24a58ea6af6f0f7d36dedd0f7d (diff)
downloadgit-htmldocs-7d06a8aba96d4197610b089a0862b46d84a36f53.tar.gz
Autogenerated HTML docs for v1.6.0.2-588-g3102
Diffstat (limited to 'git-describe.txt')
-rw-r--r--git-describe.txt9
1 files changed, 7 insertions, 2 deletions
diff --git a/git-describe.txt b/git-describe.txt
index c4dbc2ae3..3d79f0599 100644
--- a/git-describe.txt
+++ b/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