From: Greg Price <price@MIT.EDU>
Date: Mon, 25 Feb 2013 05:29:01 +0000 (-0500)
Subject: describe: Document --match pattern format
X-Git-Tag: v1.8.1.6~23^2
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=52291497d1ea112137237e6c719e832599eab526;p=git

describe: Document --match pattern format

It's not clear in git-describe(1) what kind of "pattern" should be
passed to --match.  Fix that.

Signed-off-by: Greg Price <price@mit.edu>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
---

diff --git a/Documentation/git-describe.txt b/Documentation/git-describe.txt
index 72d6bb612b..711040d2f1 100644
--- a/Documentation/git-describe.txt
+++ b/Documentation/git-describe.txt
@@ -81,8 +81,9 @@ OPTIONS
 	that points at object deadbee....).
 
 --match <pattern>::
-	Only consider tags matching the given pattern (can be used to avoid
-	leaking private tags made from the repository).
+	Only consider tags matching the given `glob(7)` pattern,
+	excluding the "refs/tags/" prefix.  This can be used to avoid
+	leaking private tags from the repository.
 
 --always::
 	Show uniquely abbreviated commit object as fallback.