1f010d6bdf
We presently use the ".txt" extension for our AsciiDoc files. While not wrong, most editors do not associate this extension with AsciiDoc, meaning that contributors don't get automatic editor functionality that could be useful, such as syntax highlighting and prose linting. It is much more common to use the ".adoc" extension for AsciiDoc files, since this helps editors automatically detect files and also allows various forges to provide rich (HTML-like) rendering. Let's do that here, renaming all of the files and updating the includes where relevant. Adjust the various build scripts and makefiles to use the new extension as well. Note that this should not result in any user-visible changes to the documentation. Signed-off-by: brian m. carlson <sandals@crustytoothpaste.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
67 lines
1.7 KiB
Plaintext
67 lines
1.7 KiB
Plaintext
git-mktag(1)
|
|
============
|
|
|
|
NAME
|
|
----
|
|
git-mktag - Creates a tag object with extra validation
|
|
|
|
|
|
SYNOPSIS
|
|
--------
|
|
[verse]
|
|
'git mktag'
|
|
|
|
DESCRIPTION
|
|
-----------
|
|
|
|
Reads a tag's 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 linkgit:git-fsck[1] check.
|
|
|
|
The "fsck" check done by mktag is stricter than what linkgit:git-fsck[1]
|
|
would run by default in that all `fsck.<msg-id>` messages are promoted
|
|
from warnings to errors (so e.g. a missing "tagger" line is an error).
|
|
|
|
Extra headers in the object are also an error under mktag, but ignored
|
|
by linkgit:git-fsck[1]. This extra check can be turned off by setting
|
|
the appropriate `fsck.<msg-id>` variable:
|
|
|
|
git -c fsck.extraHeaderEntry=ignore mktag <my-tag-with-headers
|
|
|
|
OPTIONS
|
|
-------
|
|
|
|
--strict::
|
|
By default mktag turns on the equivalent of
|
|
linkgit:git-fsck[1] `--strict` mode. Use `--no-strict` to
|
|
disable it.
|
|
|
|
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 a `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
|