diff options
| author | Jeff King <peff@peff.net> | 2012-07-23 17:13:12 -0400 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2012-07-23 15:10:36 -0700 |
| commit | 41f597d9bbac33a7e522c5f74b83e712ea2de13a (patch) | |
| tree | eaea4a0820b311812bcd165b37bb7aecd0adde7e | |
| parent | e6dfbcf12b0e70897818cb36903de0625931a5c6 (diff) | |
| download | git-41f597d9bbac33a7e522c5f74b83e712ea2de13a.tar.gz git-41f597d9bbac33a7e522c5f74b83e712ea2de13a.tar.xz | |
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>
| -rw-r--r-- | Documentation/git-commit.txt | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt index 2d695f619..81853e964 100644 --- a/Documentation/git-commit.txt +++ b/Documentation/git-commit.txt @@ -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 -------- |