Merge branch 'mo/status-untracked'

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

diff --git a/Documentation/git-describe.txt b/Documentation/git-describe.txt
index d9aa2f29809eb07385468edd2587daf55339389a..9f6f4831864a3112119bc7d7fec22aa7a72225e5 100644 (file)
--- a/Documentation/git-describe.txt
+++ b/Documentation/git-describe.txt
@@ -13,9 +13,10 @@ SYNOPSIS
 DESCRIPTION
 -----------
 The command finds the most recent tag that is reachable from a
-commit, and if the commit itself is pointed at by the tag, shows
-the tag.  Otherwise, it suffixes the tag name with the number of
-additional commits and the abbreviated object name of the commit.
+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.
 
 
 OPTIONS
@@ -69,6 +70,9 @@ OPTIONS
        Only consider tags matching the given pattern (can be used to avoid
        leaking private tags made from the repository).
 
+--always::
+       Show uniquely abbreviated commit object as fallback.
+
 EXAMPLES
 --------
 
@@ -141,4 +145,4 @@ Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel
 
 GIT
 ---
-Part of the linkgit:git[7] suite
+Part of the linkgit:git[1] suite