path: root/devdocs/git/git-mktag.html

<h1>git-mktag</h1>  <h2 id="_name">Name</h2> <div class="sectionbody">  <p>git-mktag - Creates a tag object with extra validation</p>  </div>   <h2 id="_synopsis">Synopsis</h2> <div class="sectionbody"> <div class="verseblock"> <pre class="content" data-language="shell">git mktag</pre> </div> </div>   <h2 id="_description">Description</h2> <div class="sectionbody">  <p>Reads a tag’s contents on standard input and creates a tag object. The output is the new tag’s &lt;object&gt; identifier.</p>   <p>This command is mostly equivalent to <a href="git-hash-object">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 class="literalblock"> <div class="content"> <pre data-language="shell">git mktag &lt;my-tag
git hash-object -t tag -w --stdin &lt;my-tag</pre> </div> </div>  <p>The difference is that mktag will die before writing the tag if the tag doesn’t pass a <a href="git-fsck">git-fsck[1]</a> check.</p>   <p>The "fsck" check done by mktag is stricter than what <a href="git-fsck">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>   <p>Extra headers in the object are also an error under mktag, but ignored by <a href="git-fsck">git-fsck[1]</a>. This extra check can be turned off by setting the appropriate <code>fsck.&lt;msg-id&gt;</code> variable:</p>  <div class="literalblock"> <div class="content"> <pre data-language="shell">git -c fsck.extraHeaderEntry=ignore mktag &lt;my-tag-with-headers</pre> </div> </div> </div>   <h2 id="_options">Options</h2> <div class="sectionbody"> <div class="dlist"> <dl> <dt class="hdlist1" id="Documentation/git-mktag.txt---strict"> --strict </dt> <dd> <p>By default mktag turns on the equivalent of <a href="git-fsck">git-fsck[1]</a> <code>--strict</code> mode. Use <code>--no-strict</code> to disable it.</p> </dd> </dl> </div> </div>   <h2 id="_tag_format">Tag format</h2> <div class="sectionbody">  <p>A tag signature file, to be fed to this command’s standard input, has a very simple fixed format: four lines of</p>  <div class="literalblock"> <div class="content"> <pre>object &lt;hash&gt;
type &lt;typename&gt;
tag &lt;tagname&gt;
tagger &lt;tagger&gt;</pre> </div> </div>  <p>followed by some <code>optional</code> free-form message (some tags created by older Git may not have a <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’t care about, but that can be verified with gpg.</p>  </div><div class="_attribution">
  <p class="_attribution-p">
    &copy; 2012&ndash;2024 Scott Chacon and others<br>Licensed under the MIT License.<br>
    <a href="https://git-scm.com/docs/git-mktag" class="_attribution-link">https://git-scm.com/docs/git-mktag</a>
  </p>
</div>