[PATCH v5] Add log.abbrevCommit config variable

[PATCH v5] Add log.abbrevCommit config variable

[Jay Soffian]

Add log.abbrevCommit config variable as a convenience for users who
often use --abbrev-commit with git log and friends. Allow the option
to be overridden with --no-abbrev-commit. Per 635530a2fc and 4f62c2bc57,
the config variable is ignored when log is given "--pretty=raw".

(Also, a drive-by spelling correction in git log's short help.)

Signed-off-by: Jay Soffian <jaysoffian@gmail.com>
---
- Fixed regression in "git reflog" output where commit was not abbreviated
- Added tests for "git whatchanged" and "git reflog" output formats
- Added additional stanzas to "log.abbrevCommit" test to check output
  of "git whatchanged" and "git reflog"

 Documentation/config.txt         |    5 ++++
 Documentation/pretty-options.txt |    5 ++++
 builtin/log.c                    |   24 ++++++++++++++--------
 revision.c                       |    3 ++
 revision.h                       |    1 +
 t/t4202-log.sh                   |   40 ++++++++++++++++++++++++++++++++++++++
 6 files changed, 69 insertions(+), 9 deletions(-)

diff --git a/Documentation/config.txt b/Documentation/config.txt
index 1a060ecbc8..6b93777199 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -1315,6 +1315,11 @@ interactive.singlekey::
 	setting is silently ignored if portable keystroke input
 	is not available.
 
+log.abbrevCommit::
+	If true, makes linkgit:git-log[1], linkgit:git-show[1], and
+	linkgit:git-whatchanged[1] assume `\--abbrev-commit`. You may
+	override this option with `\--no-abbrev-commit`.
+
 log.date::
 	Set the default date-time mode for the 'log' command.
 	Setting a value for log.date is similar to using 'git log''s
diff --git a/Documentation/pretty-options.txt b/Documentation/pretty-options.txt
index d5c977262a..2a3dc8664f 100644
--- a/Documentation/pretty-options.txt
+++ b/Documentation/pretty-options.txt
@@ -19,6 +19,11 @@ configuration (see linkgit:git-config[1]).
 This should make "--pretty=oneline" a whole lot more readable for
 people using 80-column terminals.
 
+--no-abbrev-commit::
+	Show the full 40-byte hexadecimal commit object name. This negates
+	`--abbrev-commit` and those options which imply it such as
+	"--oneline". It also overrides the 'log.abbrevCommit' variable.
+
 --oneline::
 	This is a shorthand for "--pretty=oneline --abbrev-commit"
 	used together.
diff --git a/builtin/log.c b/builtin/log.c
index f6219909a7..019a44ac86 100644
--- a/builtin/log.c
+++ b/builtin/log.c
@@ -23,6 +23,7 @@
 /* Set a default date-time format for git log ("log.date" config variable) */
 static const char *default_date_mode = NULL;
 
+static int default_abbrev_commit;
 static int default_show_root = 1;
 static int decoration_style;
 static int decoration_given;
@@ -77,6 +78,7 @@ static void cmd_log_init_defaults(struct rev_info *rev)
 		get_commit_format(fmt_pretty, rev);
 	rev->verbose_header = 1;
 	DIFF_OPT_SET(&rev->diffopt, RECURSIVE);
+	rev->abbrev_commit = default_abbrev_commit;
 	rev->show_root_diff = default_show_root;
 	rev->subject_prefix = fmt_patch_subject_prefix;
 	DIFF_OPT_SET(&rev->diffopt, ALLOW_TEXTCONV);
@@ -92,7 +94,7 @@ static void cmd_log_init_finish(int argc, const char **argv, const char *prefix,
 	int quiet = 0, source = 0;
 
 	const struct option builtin_log_options[] = {
-		OPT_BOOLEAN(0, "quiet", &quiet, "supress diff output"),
+		OPT_BOOLEAN(0, "quiet", &quiet, "suppress diff output"),
 		OPT_BOOLEAN(0, "source", &source, "show source"),
 		{ OPTION_CALLBACK, 0, "decorate", NULL, NULL, "decorate options",
 		  PARSE_OPT_OPTARG, decorate_callback},
@@ -129,13 +131,13 @@ static void cmd_log_init_finish(int argc, const char **argv, const char *prefix,
 	if (source)
 		rev->show_source = 1;
 
-	/*
-	 * defeat log.decorate configuration interacting with --pretty=raw
-	 * from the command line.
-	 */
-	if (!decoration_given && rev->pretty_given
-	    && rev->commit_format == CMIT_FMT_RAW)
-		decoration_style = 0;
+	if (rev->pretty_given && rev->commit_format == CMIT_FMT_RAW) {
+		/* "log --pretty=raw" is special */
+		if (!decoration_given)
+			decoration_style = 0;
+		if (!rev->abbrev_commit_given)
+			rev->abbrev_commit = 0;
+	}
 
 	if (decoration_style) {
 		rev->show_decorations = 1;
@@ -323,6 +325,10 @@ static int git_log_config(const char *var, const char *value, void *cb)
 		return git_config_string(&fmt_pretty, var, value);
 	if (!strcmp(var, "format.subjectprefix"))
 		return git_config_string(&fmt_patch_subject_prefix, var, value);
+	if (!strcmp(var, "log.abbrevcommit")) {
+		default_abbrev_commit = git_config_bool(var, value);
+		return 0;
+	}
 	if (!strcmp(var, "log.date"))
 		return git_config_string(&default_date_mode, var, value);
 	if (!strcmp(var, "log.decorate")) {
@@ -516,11 +522,11 @@ int cmd_log_reflog(int argc, const char **argv, const char *prefix)
 
 	init_revisions(&rev, prefix);
 	init_reflog_walk(&rev.reflog_info);
-	rev.abbrev_commit = 1;
 	rev.verbose_header = 1;
 	memset(&opt, 0, sizeof(opt));
 	opt.def = "HEAD";
 	cmd_log_init_defaults(&rev);
+	rev.abbrev_commit = 1;
 	rev.commit_format = CMIT_FMT_ONELINE;
 	rev.use_terminator = 1;
 	rev.always_show_header = 1;
diff --git a/revision.c b/revision.c
index a7cf79bf2e..be74bf92f5 100644
--- a/revision.c
+++ b/revision.c
@@ -1429,6 +1429,9 @@ static int handle_revision_opt(struct rev_info *revs, int argc, const char **arg
 			revs->abbrev = 40;
 	} else if (!strcmp(arg, "--abbrev-commit")) {
 		revs->abbrev_commit = 1;
+		revs->abbrev_commit_given = 1;
+	} else if (!strcmp(arg, "--no-abbrev-commit")) {
+		revs->abbrev_commit = 0;
 	} else if (!strcmp(arg, "--full-diff")) {
 		revs->diff = 1;
 		revs->full_diff = 1;
diff --git a/revision.h b/revision.h
index bca9947977..5e1f5c7e8f 100644
--- a/revision.h
+++ b/revision.h
@@ -90,6 +90,7 @@ struct rev_info {
 			show_notes_given:1,
 			pretty_given:1,
 			abbrev_commit:1,
+			abbrev_commit_given:1,
 			use_terminator:1,
 			missing_newline:1,
 			date_mode_explicit:1;
diff --git a/t/t4202-log.sh b/t/t4202-log.sh
index 2fcc31a6f3..f709d5c099 100755
--- a/t/t4202-log.sh
+++ b/t/t4202-log.sh
@@ -450,6 +450,46 @@ test_expect_success 'log.decorate configuration' '
 
 '
 
+test_expect_success 'reflog is expected format' '
+	test_might_fail git config --remove-section log &&
+	git log -g --abbrev-commit --pretty=oneline >expect &&
+	git reflog >actual &&
+	test_cmp expect actual
+'
+
+test_expect_success 'whatchanged is expected format' '
+	git log --no-merges --raw >expect &&
+	git whatchanged >actual &&
+	test_cmp expect actual
+'
+
+test_expect_success 'log.abbrev-commit configuration' '
+	test_when_finished "git config --unset log.abbrevCommit" &&
+
+	git log >expect.full &&
+	git log --abbrev-commit >expect.abbrev &&
+	git log --pretty=raw >expect.raw &&
+	git log -g --abbrev-commit --pretty=oneline >expect.reflog &&
+	git whatchanged --abbrev-commit >expect.whatchanged &&
+
+	git config log.abbrevCommit true &&
+
+	git log --no-abbrev-commit >actual.full &&
+	test_cmp expect.full actual.full &&
+
+	git log >actual.abbrev &&
+	test_cmp expect.abbrev actual.abbrev &&
+
+	git log --pretty=raw >actual.raw &&
+	test_cmp expect.raw actual.raw &&
+
+	git reflog >actual.reflog &&
+	test_cmp expect.reflog actual.reflog
+
+	git whatchanged >actual.whatchanged &&
+	test_cmp expect.whatchanged actual.whatchanged
+'
+
 test_expect_success 'show added path under "--follow -M"' '
 	# This tests for a regression introduced in v1.7.2-rc0~103^2~2
 	test_create_repo regression &&
-- 
1.7.5.1.340.g32d9b

Re: [PATCH v5] Add log.abbrevCommit config variable

[Junio C Hamano]

Jay Soffian <jaysoffian@gmail.com> writes:

> +test_expect_success 'log.abbrev-commit configuration' '
> +	test_when_finished "git config --unset log.abbrevCommit" &&
> +
> +	git log >expect.full &&
> +	git log --abbrev-commit >expect.abbrev &&
> +	git log --pretty=raw >expect.raw &&
> +	git log -g --abbrev-commit --pretty=oneline >expect.reflog &&
> +	git whatchanged --abbrev-commit >expect.whatchanged &&
> +
> +	git config log.abbrevCommit true &&
> +
> +	git log --no-abbrev-commit >actual.full &&
> +	test_cmp expect.full actual.full &&
> +
> +	git log >actual.abbrev &&
> +	test_cmp expect.abbrev actual.abbrev &&
> +
> +	git log --pretty=raw >actual.raw &&
> +	test_cmp expect.raw actual.raw &&
> +
> +	git reflog >actual.reflog &&
> +	test_cmp expect.reflog actual.reflog
> +
> +	git whatchanged >actual.whatchanged &&
> +	test_cmp expect.whatchanged actual.whatchanged
> +'

I can see you are testing all the commands in the "log" family for cases
where the new configuration _should_ take effect, but I cannot see the
same throughness for the negative case where the configuration should not
kick in. Is "log" the only one that you make sure --no-abbrev-commit
defeats the configuration? Please always test both sides of the coin.

Other than that, the patch looked fine from my cursory look.

Thanks.

Re: [PATCH v5] Add log.abbrevCommit config variable

[Jay Soffian]

On Wed, May 18, 2011 at 12:22 AM, Junio C Hamano <gitster@pobox.com> wrote:
> Other than that, the patch looked fine from my cursory look.

Thanks, I hope v7 addresses all concerns.

j.