Make help entries alphabetical

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

diff --git a/Documentation/git-mktag.txt b/Documentation/git-mktag.txt
index 320f5a1efb3ecd8443e01da714bdb6470d85838c..8bcc11443dce7322ac5b0fa70e07b2465f762615 100644 (file)
--- a/Documentation/git-mktag.txt
+++ b/Documentation/git-mktag.txt
@@ -1,6 +1,5 @@
 git-mktag(1)
 ============
-v0.1, May 2005
 
 NAME
 ----
@@ -9,12 +8,29 @@ git-mktag - Creates a tag object
 
 SYNOPSIS
 --------
-'git-mktag'
+'git mktag' < signature_file
 
 DESCRIPTION
 -----------
-Reads a tag contents from its standard input and creates a tag object.
-The input must be a well formed tag object.
+Reads a tag contents on standard input and creates a tag object
+that can also be used to sign other objects.
+
+The output is the new tag's <object> identifier.
+
+Tag Format
+----------
+A tag signature file has a very simple fixed format: four lines of
+
+  object <sha1>
+  type <typename>
+  tag <tagname>
+  tagger <tagger>
+
+followed by some 'optional' free-form message (some tags created
+by older git may not have `tagger` line).  The message, when
+exists, is separated by a blank line from the header.  The
+message part may contain a signature that git itself doesn't
+care about, but that can be verified with gpg.
 
 
 Author
@@ -27,5 +43,4 @@ Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel
 
 GIT
 ---
-Part of the link:git.html[git] suite
-
+Part of the linkgit:git[1] suite