Add "git" and "git-log-script" helper scripts.
[gitweb.git] / Documentation / git-mktag.txt
index 320f5a1efb3ecd8443e01da714bdb6470d85838c..708f4ef8dad1b41628a1afcc1bc75a1bae89fa4e 100644 (file)
@@ -9,12 +9,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: three lines of
+
+  object <sha1>
+  type <typename>
+  tag <tagname>
+
+followed by some 'optional' free-form signature that git itself
+doesn't care about, but that can be verified with gpg or similar.
+
+The size of the full object is artificially limited to 8kB.  (Just
+because I'm a lazy bastard, and if you can't fit a signature in that
+size, you're doing something wrong)
 
 
 Author