Skip to content

Commit 41f597d

Browse files
peffgitster
authored andcommitted
commit: document the temporary commit message file
We do not document COMMIT_EDITMSG at all, but users may want to know about it for two reasons: 1. They may want to tell their editor to configure itself for formatting a commit message. 2. If a commit is aborted by an error, the user may want to recover the commit message they typed. Let's put a note in git-commit(1). Signed-off-by: Jeff King <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent e6dfbcf commit 41f597d

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

Documentation/git-commit.txt

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -399,6 +399,15 @@ This command can run `commit-msg`, `prepare-commit-msg`, `pre-commit`,
399399
and `post-commit` hooks. See linkgit:githooks[5] for more
400400
information.
401401

402+
FILES
403+
-----
404+
405+
`$GIT_DIR/COMMIT_EDITMSG`::
406+
This file contains the commit message of a commit in progress.
407+
If `git commit` exits due to an error before creating a commit,
408+
any commit message that has been provided by the user (e.g., in
409+
an editor session) will be available in this file, but will be
410+
overwritten by the next invocation of `git commit`.
402411

403412
SEE ALSO
404413
--------

0 commit comments

Comments
 (0)