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 <frederik@ofb.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Frederick Eaton committed
Sep 19, 2018 at 13:12 UTC
55f6bce2c9efe7f8a4d2186232aa8227142d9435
1 file changed
+3
-1
Documentation/git-describe.txt
+3
-1
@@ -18,7 +18,9 @@ The command finds the most recent tag that is reachable from a
18
commit. If the tag points to the commit, then only the tag is
19
shown. Otherwise, it suffixes the tag name with the number of
20
additional commits on top of the tagged object and the
21
-abbreviated object name of the most recent commit.
21
+abbreviated object name of the most recent commit. The result
22
+is a "human-readable" object name which can also be used to
23
+identify the commit to other git commands.
24
25
By default (without --all or --tags) `git describe` only shows
26
annotated tags. For more information about creating annotated tags