Skip to content

Commit 719515f

Browse files
LemmingAvalanchegitster
authored andcommitted
doc: tag: document TAG_EDITMSG
Document `TAG_EDITMSG` which we have told the user about on unsuccessful command invocations since commit 3927bbe (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 3927bbe: “ This matches the behavior of COMMIT_EDITMSG, which stays around in case of error. Suggested-by: Junio C Hamano <[email protected]> Signed-off-by: Kristoffer Haugsbakk <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 5bc069e commit 719515f

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

Documentation/git-tag.txt

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -381,6 +381,16 @@ $ GIT_COMMITTER_DATE="2006-10-02 10:31" git tag -s v1.0.1
381381

382382
include::date-formats.txt[]
383383

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+
384394
NOTES
385395
-----
386396

0 commit comments

Comments
 (0)