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 <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Jeff King committed
Jul 23, 2012 at 17:13 UTC
41f597d9bbac33a7e522c5f74b83e712ea2de13a
1 file changed
+9
Documentation/git-commit.txt
+9
@@ -399,6 +399,15 @@ This command can run `commit-msg`, `prepare-commit-msg`, `pre-commit`,
399
and `post-commit` hooks. See linkgit:githooks[5] for more
400
information.
401
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`.
411
412
SEE ALSO
413
--------