summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorRyan Anderson <ryan@michonline.com>2005-07-25 06:17:16 (GMT)
committerJunio C Hamano <junkio@cox.net>2005-07-25 23:34:26 (GMT)
commitb7e438f951f68be704b001343811e9ff89da07f7 (patch)
tree5359df3cf02f917c1b8749d9af3396dc25e8c44b /Documentation
parent0fad0fdd4beadb2ff06af8d5a16d509cd8796ee4 (diff)
downloadgit-b7e438f951f68be704b001343811e9ff89da07f7.zip
git-b7e438f951f68be704b001343811e9ff89da07f7.tar.gz
git-b7e438f951f68be704b001343811e9ff89da07f7.tar.bz2
Update the documentation for git-tag-script to reflect current behavior.
[jc: I updated Ryan's patch to mention -a to create an unsigned tag.] Signed-off-by: Ryan Anderson <ryan@michonline.com>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/git-tag-script.txt16
1 files changed, 11 insertions, 5 deletions
diff --git a/Documentation/git-tag-script.txt b/Documentation/git-tag-script.txt
index daf350b..2df396e 100644
--- a/Documentation/git-tag-script.txt
+++ b/Documentation/git-tag-script.txt
@@ -4,18 +4,25 @@ v0.1, May 2005
NAME
----
-git-tag-script - An example script to create a tag object signed with GPG
+git-tag-script - Create a tag object signed with GPG
SYNOPSIS
--------
-'git-tag-script'
+'git-tag-script' [-s | -a] [-f] <name>
DESCRIPTION
-----------
-This is an example script that uses "git-mktag" to create a tag object
-signed with GPG.
+Adds a "tag" reference in .git/refs/tags/
+
+Unless "-f" is given, the tag must not yet exist in ".git/refs/tags"
+
+If "-s" or "-a" is passed, the user will be prompted for a tag message.
+and a tag object is created. Otherwise just the SHA1 object
+name of the commit object is written.
+
+A GnuPG signed tag object will be created when "-s" is used.
Author
@@ -29,4 +36,3 @@ Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel
GIT
---
Part of the link:git.html[git] suite
-