[PATCH 3/3] git-describe.1: clarify that "human readable" is also git-readable
- From
- Frederick Eaton <frederik@ofb.net>
- Date
- Sep 19, 2018, 20:12 UTC
- Message-ID
- <20180919201231.609-4-frederik@ofb.net>
- In-Reply-To
- <20180919201231.609-1-frederik@ofb.net>
The caption uses the term "human readable", but the DESCRIPTION did not explain this in context.
Signed-off-by: Frederick Eaton <frederik@ofb.net> --- Documentation/git-describe.txt | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/Documentation/git-describe.txt b/Documentation/git-describe.txt index e027fb8c4..ccdc5f83d 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
-- 2.19.0