Merge branch 'mk/grep-max-depth'

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

diff --git a/Documentation/git-tag.txt b/Documentation/git-tag.txt
index 533d18bbd5634bf6197960f546a20772386c824a..1118ce22dcfcbaf190bd7abc60c2b33c213acd06 100644 (file)
--- a/Documentation/git-tag.txt
+++ b/Documentation/git-tag.txt
@@ -17,7 +17,10 @@ SYNOPSIS
 
 DESCRIPTION
 -----------
-Adds a 'tag' reference in `.git/refs/tags/`
+
+Adds a 'tag' reference in `.git/refs/tags/`.  The tag <name> must pass
+linkgit:git-check-ref-format[1] which basicly means that control characters,
+space, ~, ^, :, ?, *, [ and \ are prohibited.
 
 Unless `-f` is given, the tag must not yet exist in
 `.git/refs/tags/` directory.
@@ -63,6 +66,7 @@ OPTIONS
        are printed when using -l.
        The default is not to print any annotation lines.
        If no number is given to `-n`, only the first line is printed.
+       If the tag is not annotated, the commit message is displayed instead.
 
 -l <pattern>::
        List tags with names that match the given pattern (or all if no pattern is given).