path: root/Documentation/git-describe.txt
diff options
authorFrederick Eaton <>2018-09-19 20:12:31 (GMT)
committerJunio C Hamano <>2018-09-21 16:32:21 (GMT)
commit55f6bce2c9efe7f8a4d2186232aa8227142d9435 (patch)
tree324b4a7cca3704a144de18ac275f6f6eb06fc929 /Documentation/git-describe.txt
parent6271d94769c4db0a2938761d255a438289561639 (diff)
git-describe.1: clarify that "human readable" is also git-readable
The caption uses the term "human readable", but the DESCRIPTION did not explain this in context. Signed-off-by: Frederick Eaton <> Signed-off-by: Junio C Hamano <>
Diffstat (limited to 'Documentation/git-describe.txt')
1 files changed, 3 insertions, 1 deletions
diff --git a/Documentation/git-describe.txt b/Documentation/git-describe.txt
index e027fb8..ccdc5f8 100644
--- a/Documentation/git-describe.txt
+++ b/Documentation/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