Merge branch 'jk/maint-commit-document-editmsg' into maint
authorJunio C Hamano <gitster@pobox.com>
Mon, 30 Jul 2012 20:05:36 +0000 (13:05 -0700)
committerJunio C Hamano <gitster@pobox.com>
Mon, 30 Jul 2012 20:05:36 +0000 (13:05 -0700)
"$GIT_DIR/COMMIT_EDITMSG" file that is used to hold the commit log
message user edits was not documented.

* jk/maint-commit-document-editmsg:
commit: document the temporary commit message file

Documentation/git-commit.txt
index 2d695f619ceff358a3bc7c1e66532cc077ca3065..81853e9646dbe657e89e353785c4beda01c545b3 100644 (file)
@@ -399,6 +399,15 @@ This command can run `commit-msg`, `prepare-commit-msg`, `pre-commit`,
 and `post-commit` hooks.  See linkgit:githooks[5] for more
 information.
 
+FILES
+-----
+
+`$GIT_DIR/COMMIT_EDITMSG`::
+       This file contains the commit message of a commit in progress.
+       If `git commit` exits due to an error before creating a commit,
+       any commit message that has been provided by the user (e.g., in
+       an editor session) will be available in this file, but will be
+       overwritten by the next invocation of `git commit`.
 
 SEE ALSO
 --------