diff options
| author | Kristoffer Haugsbakk <code@khaugsbakk.name> | 2023-05-16 19:55:44 +0200 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2023-05-16 11:38:14 -0700 |
| commit | 719515fdd0a951f51751e12fefa79cb25c6ae15d (patch) | |
| tree | 2b2c2e8f949ee8c2091b9ce2a329f06c2bf9fbf3 /Documentation/git-tag.txt | |
| parent | 5bc069e383539824fd3a0d897100d44bbe1f8a24 (diff) | |
| download | git-719515fdd0a951f51751e12fefa79cb25c6ae15d.tar.gz | |
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>
Diffstat (limited to 'Documentation/git-tag.txt')
| -rw-r--r-- | Documentation/git-tag.txt | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/Documentation/git-tag.txt b/Documentation/git-tag.txt index 7f61c1edb3..d42efb3112 100644 --- a/Documentation/git-tag.txt +++ b/Documentation/git-tag.txt @@ -381,6 +381,16 @@ $ GIT_COMMITTER_DATE="2006-10-02 10:31" git tag -s v1.0.1 include::date-formats.txt[] +FILES +----- + +`$GIT_DIR/TAG_EDITMSG`:: + This file contains the message of an in-progress annotated + tag. If `git tag` exits due to an error before creating an + annotated tag then the tag message that has been provided by the + user in an editor session will be available in this file, but + may be overwritten by the next invocation of `git tag`. + NOTES ----- |