git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH v6 3/3] commit::print_summary(): don't use format_commit_message()

From
Tay Ray Chuan <rctay89@gmail.com>
Date
Jun 12, 2010, 14:15 UTC
Message-ID
<1276352139-2272-1-git-send-email-rctay89@gmail.com>
In-Reply-To
<1274974492-4692-4-git-send-email-rctay89@gmail.com>

This attempts to fix a regression in git-commit, where non-abbreviated SHA-1s were printed in the summary.

One possible fix would be to set ctx.abbrev to DEFAULT_ABBREV in the `if` block, where format_commit_message() is used.

Instead, we do away with the format_commit_message() codeblock altogether, replacing it with a re-run of log_tree_commit().

We re-run log_tree_commit() with rev.always_show_header set, to force the invocation of show_log(). The effect of this flag can be seen from this excerpt from log-tree.c:560, the only area that rev.always_show_header is checked:

	shown = log_tree_diff(opt, commit, &log);
	if (!shown && opt->loginfo && opt->always_show_header) {
		log.parent = NULL;
		show_log(opt);
		shown = 1;
	}

We also set rev.use_terminator, so that a newline is appended at the end of the log message. Note that callers in builtin/log.c that also set rev.always_show_header don't have to set rev.use_terminator, but still get a newline, because they are wrapped in a pager.

Signed-off-by: Tay Ray Chuan <rctay89@gmail.com>
---

This is a reworked version of the third patch of the 'tc/commit-abbrev-fix' series; there are no changes to the first and second patches.

Changes from v5:
 - don't set rev.always_show_header immediately, so that when there is
   no diff, log_tree_commit() returns false, as before the patch;
 - when log_tree_commit() returns false (ie. no diff), set
   rev.always_show_header, and re-run log_tree_commit();
 - add a missing newline to summary output by setting
   rev.use_terminator.
See the patch message for more details.
In case you're wondering where's v5, it was sent in a private review:
  http://github.com/gitster/git/commit/c69160d
 builtin/commit.c  |   10 ++++------
 t/t7502-commit.sh |    4 ++--
 2 files changed, 6 insertions(+), 8 deletions(-)
diff --git a/builtin/commit.c b/builtin/commit.c
index a4e4966..aa92362 100644
--- a/builtin/commit.c
+++ b/builtin/commit.c
@@ -1163,13 +1163,11 @@ static void print_summary(const char *prefix, const unsigned char *sha1)
 		initial_commit ? " (root-commit)" : "");

 	if (!log_tree_commit(&rev, commit)) {
-		struct pretty_print_context ctx = {0};
-		struct strbuf buf = STRBUF_INIT;
-		ctx.date_mode = DATE_NORMAL;
-		format_commit_message(commit, format.buf + 7, &buf, &ctx);
-		printf("%s\n", buf.buf);
-		strbuf_release(&buf);
+		rev.always_show_header = 1;
+		rev.use_terminator = 1;
+		log_tree_commit(&rev, commit);
 	}
+
 	strbuf_release(&format);
 }

diff --git a/t/t7502-commit.sh b/t/t7502-commit.sh
index b10541d..08c0247 100755
--- a/t/t7502-commit.sh
+++ b/t/t7502-commit.sh
@@ -36,12 +36,12 @@ test_expect_success 'output summary format' '
 	check_summary_oneline "" "a change"
 '

-test_expect_failure 'output summary format for commit with an empty diff' '
+test_expect_success 'output summary format for commit with an empty diff' '

 	check_summary_oneline "" "empty" "--allow-empty"
 '

-test_expect_failure 'output summary format for merges' '
+test_expect_success 'output summary format for merges' '

 	git checkout -b recursive-base &&
 	test_commit base file1 &&
--
1.7.1.189.g07419
Previous: Tay Ray ChuanNext: Will Palmer
Message 16 of 17 in “commit: fix abbrev-sha regression”
  1. 0/3 commit: fix abbrev-sha regressionTay Ray Chuan, May 24, 2010
  2. 1/3 t7502-commit: add tests for summary outputTay Ray Chuan, May 24, 2010
  3. 2/3 t7502-commit: add summary output tests for empty and merge commitsTay Ray Chuan, May 24, 2010
  4. 3/3 commit: show abbreviated sha for commits with empty diffsTay Ray Chuan, May 24, 2010
  5. Junio C HamanoMay 26, 2010
  6. Tay Ray ChuanMay 26, 2010
  7. Tay Ray ChuanMay 26, 2010
  8. Junio C HamanoMay 26, 2010
  9. Tay Ray ChuanMay 26, 2010
  10. 0/3 commit: fix abbrev-sha regressionTay Ray Chuan, May 27, 2010
  11. 1/3 t7502-commit: add tests for summary outputTay Ray Chuan, May 27, 2010
  12. 2/3 t7502-commit: add summary output tests for empty and merge commitsTay Ray Chuan, May 27, 2010
  13. 3/3 commit::print_summary(): set rev_info.always_show_header to 1Tay Ray Chuan, May 27, 2010
  14. Junio C HamanoMay 29, 2010
  15. Tay Ray ChuanMay 29, 2010
  16. 3/3 commit::print_summary(): don't use format_commit_message()Tay Ray Chuan, Jun 12, 2010
  17. Will PalmerMay 27, 2010

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.