diff options
| author | Frederick Eaton <frederik@ofb.net> | 2018-09-19 13:12:31 -0700 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2018-09-21 09:32:21 -0700 |
| commit | 55f6bce2c9efe7f8a4d2186232aa8227142d9435 (patch) | |
| tree | 324b4a7cca3704a144de18ac275f6f6eb06fc929 /Documentation/git-describe.txt | |
| parent | 6271d94769c4db0a2938761d255a438289561639 (diff) | |
| download | git-55f6bce2c9efe7f8a4d2186232aa8227142d9435.tar.gz | |
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>
Diffstat (limited to 'Documentation/git-describe.txt')
| -rw-r--r-- | Documentation/git-describe.txt | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/Documentation/git-describe.txt b/Documentation/git-describe.txt index e027fb8c4b..ccdc5f83d6 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 |