Fix the wrong output of `git-show v1.3.0~155^2~4` in documentation.

[git.git] / Documentation / git-describe.txt

diff --git a/Documentation/git-describe.txt b/Documentation/git-describe.txt
index fbb40a29165a47e627358b5b9f8afb50e84958cd..d9aa2f29809eb07385468edd2587daf55339389a 100644 (file)
--- a/Documentation/git-describe.txt
+++ b/Documentation/git-describe.txt
@@ -56,6 +56,15 @@ OPTIONS
        being employed to standard error.  The tag name will still
        be printed to standard out.
 
        being employed to standard error.  The tag name will still
        be printed to standard out.
 

+--long::
+       Always output the long format (the tag, the number of commits
+       and the abbreviated commit name) even when it matches a tag.
+       This is useful when you want to see parts of the commit object name
+       in "describe" output, even when the commit in question happens to be
+       a tagged version.  Instead of just emitting the tag name, it will
+       describe such a commit as v1.2-0-deadbeef (0th commit since tag v1.2
+       that points at object deadbeef....).
+

 --match <pattern>::
        Only consider tags matching the given pattern (can be used to avoid
        leaking private tags made from the repository).
 --match <pattern>::
        Only consider tags matching the given pattern (can be used to avoid
        leaking private tags made from the repository).