Re: [PATCH 3/3] commit: give a hint when a commit message has been abandoned
From: Junio C Hamano <hidden>
Date: 2016-06-15 22:54:19
Subsystem:
the rest · Maintainer:
Linus Torvalds
Possibly related (same subject, not in this thread)
- 2016-06-15 · [PATCH 3/3] commit: give a hint when a commit message has been abandoned · Jeff King <hidden>
- 2016-06-15 · Re: [PATCH 3/3] commit: give a hint when a commit message has been abandoned · Junio C Hamano <hidden>
- 2016-06-15 · Re: [PATCH 3/3] commit: give a hint when a commit message has been abandoned · Jeff King <hidden>
- 2016-06-15 · Re: [PATCH 3/3] commit: give a hint when a commit message has been abandoned · Junio C Hamano <hidden>
- 2016-06-15 · Re: [PATCH 3/3] commit: give a hint when a commit message has been abandoned · Jeff King <hidden>
Jeff King [off-list ref] writes:
quoted hunk
Here's a documentation patch. -- >8 -- Subject: [PATCH] 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). --- Documentation/git-commit.txt | 9 +++++++++ 1 file changed, 9 insertions(+)diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt index f400835..87297dc 100644 --- a/Documentation/git-commit.txt +++ b/Documentation/git-commit.txt@@ -407,6 +407,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 --------
Very sensible, modulo s/git-commit/git commit/ and lack of S-o-b. I also wondered if something like the following might be useful, but it probably falls into the "water under the bridge" category. builtin/commit.c | 5 +++++ 1 file changed, 5 insertions(+)
diff --git a/builtin/commit.c b/builtin/commit.c
index 149e07d..83bcee4 100644
--- a/builtin/commit.c
+++ b/builtin/commit.c@@ -768,6 +768,11 @@ static int prepare_to_commit(const char *index_file, const char *prefix, "with '#' will be kept; you may remove them" " yourself if you want to.\n" "An empty message aborts the commit.\n")); + status_printf(s, GIT_COLOR_NORMAL, + _("The file '%s' keeps a copy of the log message\n" + "you edited, if you wish to inspect it later.\n" + "It will be wiped by the next invocation of 'git commit'.\n"), + git_path("COMMIT_EDITMSG")); if (only_include_assumed) status_printf_ln(s, GIT_COLOR_NORMAL, "%s", only_include_assumed);