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>
Kristoffer Haugsbakk committed
May 16, 2023 at 19:55 UTC
719515fdd0a951f51751e12fefa79cb25c6ae15d
1 file changed
+10
Documentation/git-tag.txt
+10
@@ -381,6 +381,16 @@ $ GIT_COMMITTER_DATE="2006-10-02 10:31" git tag -s v1.0.1
381
382
include::date-formats.txt[]
383
384
+FILES
385
+-----
386
+
387
+`$GIT_DIR/TAG_EDITMSG`::
388
+ This file contains the message of an in-progress annotated
389
+ tag. If `git tag` exits due to an error before creating an
390
+ annotated tag then the tag message that has been provided by the
391
+ user in an editor session will be available in this file, but
392
+ may be overwritten by the next invocation of `git tag`.
393
+
394
NOTES
395
-----
396