18430ed363
Change the mktag documentation to compare itself to the similar "hash-object -t tag" command. Before this someone reading the documentation wouldn't have much of an idea what the difference was. Let's allude to our own validation logic, and cross-link the "mktag" and "hash-object" documentation to aid discover-ability. A follow-up change to migrate "mktag" to use "fsck" validation will make the part about validation logic clearer. Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
49 lines
1.1 KiB
Plaintext
49 lines
1.1 KiB
Plaintext
git-mktag(1)
|
|
============
|
|
|
|
NAME
|
|
----
|
|
git-mktag - Creates a tag object with extra validation
|
|
|
|
|
|
SYNOPSIS
|
|
--------
|
|
[verse]
|
|
'git mktag'
|
|
|
|
DESCRIPTION
|
|
-----------
|
|
|
|
Reads a tag contents on standard input and creates a tag object. The
|
|
output is the new tag's <object> identifier.
|
|
|
|
This command is mostly equivalent to linkgit:git-hash-object[1]
|
|
invoked with `-t tag -w --stdin`. I.e. both of these will create and
|
|
write a tag found in `my-tag`:
|
|
|
|
git mktag <my-tag
|
|
git hash-object -t tag -w --stdin <my-tag
|
|
|
|
The difference is that mktag will die before writing the tag if the
|
|
tag doesn't pass a sanity check.
|
|
|
|
Tag Format
|
|
----------
|
|
A tag signature file, to be fed to this command's standard input,
|
|
has a very simple fixed format: four lines of
|
|
|
|
object <hash>
|
|
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 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.
|
|
|
|
GIT
|
|
---
|
|
Part of the linkgit:git[1] suite
|