diff options
| author |  Junio C Hamano <gitster@pobox.com> | 2010-01-30 16:03:10 -0800 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2010-01-30 16:03:10 -0800 |
| commit | 00d3278c8534a8244ae3447189401111e017fd5d (patch) | |
| tree | f1c19903bc10ffe4816642040080fb6cfd5da376 /Documentation/git-tag.txt | |
| parent | t6000lib: Fix permission (diff) | |
| parent | Add a small patch-mode testing library (diff) | |
| download | tgif-00d3278c8534a8244ae3447189401111e017fd5d.tar.xz | |
Merge commit 'b319ef7' into jc/maint-fix-test-perm
* commit 'b319ef7': (8132 commits)
Add a small patch-mode testing library
git-apply--interactive: Refactor patch mode code
t8005: Nobody writes Russian in shift_jis
Fix severe breakage in "git-apply --whitespace=fix"
Update release notes for 1.6.4
After renaming a section, print any trailing variable definitions
Make section_name_match start on '[', and return the length on success
send-email: detect cycles in alias expansion
Show the presence of untracked files in the bash prompt.
SunOS grep does not understand -C<n> nor -e
Fix export_marks() error handling.
git repack: keep commits hidden by a graft
Add a test showing that 'git repack' throws away grafted-away parents
git branch: clean up detached branch handling
git branch: avoid unnecessary object lookups
git branch: fix performance problem
git svn: fix shallow clone when upstream revision is too new
do_one_ref(): null_sha1 check is not about broken ref
configure.ac: properly unset NEEDS_SSL_WITH_CRYPTO when sha1 func is missing
janitor: useless checks before free
...
Diffstat (limited to 'Documentation/git-tag.txt')
| -rw-r--r-- | Documentation/git-tag.txt | 84 |
1 files changed, 61 insertions, 23 deletions
diff --git a/Documentation/git-tag.txt b/Documentation/git-tag.txt index 70235e8ddb..fa733214ab 100644 --- a/Documentation/git-tag.txt +++ b/Documentation/git-tag.txt @@ -9,9 +9,11 @@ git-tag - Create, list, delete or verify a tag object signed with GPG SYNOPSIS -------- [verse] -'git-tag' [-a | -s | -u <key-id>] [-f | -v] [-m <msg> | -F <file>] <name> [<head>] -'git-tag' -d <name>... -'git-tag' -l [<pattern>] +'git tag' [-a | -s | -u <key-id>] [-f] [-m <msg> | -F <file>] + <name> [<commit> | <object>] +'git tag' -d <name>... +'git tag' [-n[<num>]] -l [--contains <commit>] [<pattern>] +'git tag' -v <name>... DESCRIPTION ----------- @@ -22,9 +24,12 @@ Unless `-f` is given, the tag must not yet exist in If one of `-a`, `-s`, or `-u <key-id>` is passed, the command creates a 'tag' object, and requires the tag message. Unless -`-m <msg>` is given, an editor is started for the user to type +`-m <msg>` or `-F <file>` is given, an editor is started for the user to type in the tag message. +If `-m <msg>` or `-F <file>` is given and `-a`, `-s`, and `-u <key-id>` +are absent, `-a` is implied. + Otherwise just the SHA1 object name of the commit object is written (i.e. a lightweight tag). @@ -33,13 +38,6 @@ A GnuPG signed tag object will be created when `-s` or `-u committer identity for the current user is used to find the GnuPG key for signing. -`-d <tag>` deletes the tag. - -`-v <tag>` verifies the gpg signature of the tag. - -`-l <pattern>` lists tags that match the given pattern (or all -if no pattern is given). - OPTIONS ------- -a:: @@ -58,27 +56,46 @@ OPTIONS Delete existing tags with the given names. -v:: - Verify the gpg signature of given the tag + Verify the gpg signature of the given tag names. + +-n<num>:: + <num> specifies how many lines from the annotation, if any, + 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 that match the given pattern (or all if no pattern is given). + 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) + Use the given tag message (instead of prompting). + If multiple `-m` options are given, their values are + concatenated as separate paragraphs. + Implies `-a` if none of `-a`, `-s`, or `-u <key-id>` + is given. -F <file>:: Take the tag message from the given file. Use '-' to read the message from the standard input. + Implies `-a` if none of `-a`, `-s`, or `-u <key-id>` + is given. CONFIGURATION ------------- -By default, git-tag in sign-with-default mode (-s) will use your +By default, 'git-tag' in sign-with-default mode (-s) will use your committer identity (of the form "Your Name <your@email.address>") to find a key. If you want to use a different default key, you can specify it in the repository configuration as follows: +------------------------------------- [user] signingkey = <gpg-key-id> +------------------------------------- DISCUSSION @@ -106,12 +123,12 @@ and be done with it. . The insane thing. You really want to call the new version "X" too, 'even though' -others have already seen the old one. So just use "git tag -f" +others have already seen the old one. So just use 'git-tag -f' again, as if you hadn't already published the old one. -However, Git does *not* (and it should not)change tags behind -users back. So if somebody already got the old tag, doing a "git -pull" on your tree shouldn't just make them overwrite the old +However, Git does *not* (and it should not) change tags behind +users back. So if somebody already got the old tag, doing a +'git-pull' on your tree shouldn't just make them overwrite the old one. If somebody got a release tag from you, you cannot just change @@ -165,7 +182,7 @@ private anchor point tags from the other person. You would notice "please pull" messages on the mailing list says repo URL and branch name alone. This is designed to be easily -cut&pasted to "git fetch" command line: +cut&pasted to a 'git-fetch' command line: ------------ Linus, please pull from @@ -194,7 +211,7 @@ determines who are interested in whose tags. A one-shot pull is a sign that a commit history is now crossing the boundary between one circle of people (e.g. "people who are -primarily interested in networking part of the kernel") who may +primarily interested in the networking part of the kernel") who may have their own set of tags (e.g. "this is the third release candidate from the networking group to be proposed for general consumption with 2.6.21 release") to another circle of people @@ -211,10 +228,31 @@ having tracking branches. Again, the heuristic to automatically follow such tags is a good thing. +On Backdating Tags +~~~~~~~~~~~~~~~~~~ + +If you have imported some changes from another VCS and would like +to add tags for major releases of your work, it is useful to be able +to specify the date to embed inside of the tag object. The data in +the tag object affects, for example, the ordering of tags in the +gitweb interface. + +To set the date used in future tag objects, set the environment +variable GIT_COMMITTER_DATE to one or more of the date and time. The +date and time can be specified in a number of ways; the most common +is "YYYY-MM-DD HH:MM". + +An example follows. + +------------ +$ GIT_COMMITTER_DATE="2006-10-02 10:31" git tag -s v1.0.1 +------------ + + Author ------ Written by Linus Torvalds <torvalds@osdl.org>, -Junio C Hamano <junkio@cox.net> and Chris Wright <chrisw@osdl.org>. +Junio C Hamano <gitster@pobox.com> and Chris Wright <chrisw@osdl.org>. Documentation -------------- @@ -222,4 +260,4 @@ Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[1] suite |