summaryrefslogtreecommitdiffstats
path: root/git-describe.txt
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2018-10-16 16:37:35 +0900
committerJunio C Hamano <gitster@pobox.com>2018-10-16 16:37:35 +0900
commit32a7527a335c1725848d37986ce4b54ab9861c9d (patch)
tree02359b56b9036ac8a2b9967754dd74eecbe8ca2b /git-describe.txt
parent6811c064ad2e5451dbbd9b7ade4839dca12479c4 (diff)
downloadgit-htmldocs-32a7527a335c1725848d37986ce4b54ab9861c9d.tar.gz
Autogenerated HTML docs for v2.19.1-450-ga4b8a
Diffstat (limited to 'git-describe.txt')
-rw-r--r--git-describe.txt4
1 files changed, 3 insertions, 1 deletions
diff --git a/git-describe.txt b/git-describe.txt
index e027fb8c4..ccdc5f83d 100644
--- a/git-describe.txt
+++ b/git-describe.txt
@@ -18,7 +18,9 @@ The command finds the most recent tag that is reachable from a
commit. If the tag points to the commit, then only the tag is
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.
+abbreviated object name of the most recent commit. The result
+is a "human-readable" object name which can also be used to
+identify the commit to other git commands.
By default (without --all or --tags) `git describe` only shows
annotated tags. For more information about creating annotated tags