summaryrefslogtreecommitdiffstats
path: root/git-mktag.html
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2021-01-25 15:32:33 -0800
committerJunio C Hamano <gitster@pobox.com>2021-01-25 15:32:33 -0800
commit7887f9b4eb248358cc8e6937ceb87b9f072ce9e5 (patch)
treed5670ef418f9f7d4a5780ee5d3d01696abb477aa /git-mktag.html
parentd5cfc8f5a014ca40c71c8355aa37074cc885297e (diff)
downloadgit-htmldocs-7887f9b4eb248358cc8e6937ceb87b9f072ce9e5.tar.gz
Autogenerated HTML docs for v2.30.0-335-ge63628
Diffstat (limited to 'git-mktag.html')
-rw-r--r--git-mktag.html50
1 files changed, 43 insertions, 7 deletions
diff --git a/git-mktag.html b/git-mktag.html
index 8b9550c81..f3f61f978 100644
--- a/git-mktag.html
+++ b/git-mktag.html
@@ -740,7 +740,7 @@ git-mktag(1) Manual Page
<h2>NAME</h2>
<div class="sectionbody">
<p>git-mktag -
- Creates a tag object
+ Creates a tag object with extra validation
</p>
</div>
</div>
@@ -755,11 +755,47 @@ git-mktag(1) Manual Page
</div>
</div>
<div class="sect1">
+<h2 id="_options">OPTIONS</h2>
+<div class="sectionbody">
+<div class="dlist"><dl>
+<dt class="hdlist1">
+--strict
+</dt>
+<dd>
+<p>
+ By default mktag turns on the equivalent of
+ <a href="git-fsck.html">git-fsck(1)</a> <code>--strict</code> mode. Use <code>--no-strict</code> to
+ disable it.
+</p>
+</dd>
+</dl></div>
+</div>
+</div>
+<div class="sect1">
<h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody">
-<div class="paragraph"><p>Reads a tag contents on standard input and creates a tag object
-that can also be used to sign other objects.</p></div>
-<div class="paragraph"><p>The output is the new tag&#8217;s &lt;object&gt; identifier.</p></div>
+<div class="paragraph"><p>Reads a tag contents on standard input and creates a tag object. The
+output is the new tag&#8217;s &lt;object&gt; identifier.</p></div>
+<div class="paragraph"><p>This command is mostly equivalent to <a href="git-hash-object.html">git-hash-object(1)</a>
+invoked with <code>-t tag -w --stdin</code>. I.e. both of these will create and
+write a tag found in <code>my-tag</code>:</p></div>
+<div class="literalblock">
+<div class="content">
+<pre><code>git mktag &lt;my-tag
+git hash-object -t tag -w --stdin &lt;my-tag</code></pre>
+</div></div>
+<div class="paragraph"><p>The difference is that mktag will die before writing the tag if the
+tag doesn&#8217;t pass a <a href="git-fsck.html">git-fsck(1)</a> check.</p></div>
+<div class="paragraph"><p>The "fsck" check done mktag is stricter than what <a href="git-fsck.html">git-fsck(1)</a>
+would run by default in that all <code>fsck.&lt;msg-id&gt;</code> messages are promoted
+from warnings to errors (so e.g. a missing "tagger" line is an error).</p></div>
+<div class="paragraph"><p>Extra headers in the object are also an error under mktag, but ignored
+by <a href="git-fsck.html">git-fsck(1)</a>. This extra check can be turned off by setting
+the appropriate <code>fsck.&lt;msg-id&gt;</code> varible:</p></div>
+<div class="literalblock">
+<div class="content">
+<pre><code>git -c fsck.extraHeaderEntry=ignore mktag &lt;my-tag-with-headers</code></pre>
+</div></div>
</div>
</div>
<div class="sect1">
@@ -769,13 +805,13 @@ that can also be used to sign other objects.</p></div>
has a very simple fixed format: four lines of</p></div>
<div class="literalblock">
<div class="content">
-<pre><code>object &lt;sha1&gt;
+<pre><code>object &lt;hash&gt;
type &lt;typename&gt;
tag &lt;tagname&gt;
tagger &lt;tagger&gt;</code></pre>
</div></div>
<div class="paragraph"><p>followed by some <em>optional</em> free-form message (some tags created
-by older Git may not have <code>tagger</code> line). The message, when
+by older Git may not have <code>tagger</code> line). The message, when it
exists, is separated by a blank line from the header. The
message part may contain a signature that Git itself doesn&#8217;t
care about, but that can be verified with gpg.</p></div>
@@ -792,7 +828,7 @@ care about, but that can be verified with gpg.</p></div>
<div id="footer">
<div id="footer-text">
Last updated
- 2015-10-26 16:13:38 PDT
+ 2021-01-25 15:29:19 PST
</div>
</div>
</body>