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>
maint
Ryan Anderson 2005-07-25 02:17:16 -04:00 committed by Junio C Hamano
parent 0fad0fdd4b
commit b7e438f951
1 changed files with 11 additions and 5 deletions

View File

@ -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