Merge branch 'tr/maint-1.6.5-bash-prompt-show-submodule-changes'

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

diff --git a/Documentation/git-tag.txt b/Documentation/git-tag.txt
index 3546acffb5197ac2ed1a542607fc244bc31b3ae3..299b04f726b2e7662fb7db64169726eec82a5c14 100644 (file)
--- a/Documentation/git-tag.txt
+++ b/Documentation/git-tag.txt
@@ -10,14 +10,15 @@ SYNOPSIS
 --------
 [verse]
 'git tag' [-a | -s | -u <key-id>] [-f] [-m <msg> | -F <file>]
 --------
 [verse]
 'git tag' [-a | -s | -u <key-id>] [-f] [-m <msg> | -F <file>]

-       <name> [<commit> | <object>]
-'git tag' -d <name>...
-'git tag' [-n[<num>]] -l [<pattern>]
-'git tag' -v <name>...
+       <tagname> [<commit> | <object>]
+'git tag' -d <tagname>...
+'git tag' [-n[<num>]] -l [--contains <commit>] [<pattern>]
+'git tag' -v <tagname>...

 
 DESCRIPTION
 -----------
 
 DESCRIPTION
 -----------

-Adds a 'tag' reference in `.git/refs/tags/`
+
+Adds a tag reference in `.git/refs/tags/`.

 
 Unless `-f` is given, the tag must not yet exist in
 `.git/refs/tags/` directory.
 
 Unless `-f` is given, the tag must not yet exist in
 `.git/refs/tags/` directory.


@@ -50,6 +51,7 @@ OPTIONS
        Make a GPG-signed tag, using the given key
 
 -f::
        Make a GPG-signed tag, using the given key
 
 -f::

+--force::

        Replace an existing tag with the given name (instead of failing)
 
 -d::
        Replace an existing tag with the given name (instead of failing)
 
 -d::


@@ -69,6 +71,9 @@ OPTIONS
        List tags with names that match the given pattern (or all if no pattern is given).
        Typing "git tag" without arguments, also lists all tags.
 
        List tags with names that match the given pattern (or all if no pattern is given).
        Typing "git tag" without arguments, also lists all tags.
 

+--contains <commit>::
+       Only list tags which contain the specified commit.
+

 -m <msg>::
        Use the given tag message (instead of prompting).
        If multiple `-m` options are given, their values are
 -m <msg>::
        Use the given tag message (instead of prompting).
        If multiple `-m` options are given, their values are


@@ -82,6 +87,12 @@ OPTIONS
        Implies `-a` if none of `-a`, `-s`, or `-u <key-id>`
        is given.
 
        Implies `-a` if none of `-a`, `-s`, or `-u <key-id>`
        is given.
 

+<tagname>::
+       The name of the tag to create, delete, or describe.
+       The new tag name must pass all checks defined by
+       linkgit:git-check-ref-format[1].  Some of these checks
+       may restrict the characters allowed in a tag name.
+

 CONFIGURATION
 -------------
 By default, 'git-tag' in sign-with-default mode (-s) will use your
 CONFIGURATION
 -------------
 By default, 'git-tag' in sign-with-default mode (-s) will use your


@@ -246,6 +257,10 @@ $ GIT_COMMITTER_DATE="2006-10-02 10:31" git tag -s v1.0.1
 ------------
 
 
 ------------
 
 

+SEE ALSO
+--------
+linkgit:git-check-ref-format[1].
+

 Author
 ------
 Written by Linus Torvalds <torvalds@osdl.org>,
 Author
 ------
 Written by Linus Torvalds <torvalds@osdl.org>,