]> git.ipfire.org Git - thirdparty/git.git/commit
doc: tag: document `TAG_EDITMSG`
authorKristoffer Haugsbakk <code@khaugsbakk.name>
Tue, 16 May 2023 17:55:44 +0000 (19:55 +0200)
committerJunio C Hamano <gitster@pobox.com>
Tue, 16 May 2023 18:38:14 +0000 (11:38 -0700)
commit719515fdd0a951f51751e12fefa79cb25c6ae15d
tree2b2c2e8f949ee8c2091b9ce2a329f06c2bf9fbf3
parent5bc069e383539824fd3a0d897100d44bbe1f8a24
doc: tag: document `TAG_EDITMSG`

Document `TAG_EDITMSG` which we have told the user about on unsuccessful
command invocations since commit 3927bbe9a4 (tag: delete TAG_EDITMSG
only on successful tag, 2008-12-06).

Introduce this documentation since we are going to add tests for the
lifetime of this file in the case of command failure and success.

Use the documentation for `COMMIT_EDITMSG` from `git-commit.txt` as a
template since these two files share the same purpose.[1]

† 1: from commit 3927bbe9a4:

     “ This matches the behavior of COMMIT_EDITMSG, which stays around
       in case of error.

Suggested-by: Junio C Hamano <gitster@pobox.com>
Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-tag.txt