[PATCH] Update the documentation for git-tag-script to reflect current behavior.
Signed-off-by: Ryan Anderson <ryan@michonline.com>
---
Documentation/git-tag-script.txt | 12 ++++++++----
1 files changed, 8 insertions(+), 4 deletions(-)
8f1801c948cbf1187a192df1656709689ba46d61
diff --git a/Documentation/git-tag-script.txt b/Documentation/git-tag-script.txt
--- a/Documentation/git-tag-script.txt
+++ b/Documentation/git-tag-script.txt
@@ -4,18 +4,22 @@ 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] [-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" is passed, the user will be prompted for a tag message, and a GnuPG
+signed tag object will be created as well.
Author
--
Ryan Anderson
sometimes Pug Majere