diff options
author | Ævar Arnfjörð Bjarmason <avarab@gmail.com> | 2021-01-05 20:42:32 +0100 |
---|---|---|
committer | Junio C Hamano <gitster@pobox.com> | 2021-01-05 14:58:28 -0800 |
commit | 18430ed363f469d5fe6e143857b7fe72aca807ba (patch) | |
tree | 2b68c539859fc05ba8acb796c4bb7a0db4d6efd3 /Documentation/git-mktag.txt | |
parent | 9ce0fc33118892a22841f474ed239b512346c83a (diff) | |
download | git-18430ed363f469d5fe6e143857b7fe72aca807ba.tar.gz |
mktag doc: update to explain why to use this
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>
Diffstat (limited to 'Documentation/git-mktag.txt')
-rw-r--r-- | Documentation/git-mktag.txt | 17 |
1 files changed, 13 insertions, 4 deletions
diff --git a/Documentation/git-mktag.txt b/Documentation/git-mktag.txt index 1b0667e372..20af1915e9 100644 --- a/Documentation/git-mktag.txt +++ b/Documentation/git-mktag.txt @@ -3,7 +3,7 @@ git-mktag(1) NAME ---- -git-mktag - Creates a tag object +git-mktag - Creates a tag object with extra validation SYNOPSIS @@ -13,10 +13,19 @@ SYNOPSIS DESCRIPTION ----------- -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. +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 ---------- |