Web lists-archives.com

[PATCH v2] reflog: specify default pretty format in config




The output of git-reflog(1) is currently only customisable by calling
reflog with --pretty=... or overriding the "pretty.oneline" format in
the config, which is currently the default fallback.

To enhance flexibility and save typing, teach reflog to fall back to a
default format specified in the config option "reflog.pretty" unless a
different pretty format is given on the command line. This behaviour is
similar to the "format.pretty" option for git-log(1) and git-show(1).
When "reflog.pretty" is not set, fall back to the old default of
--pretty=oneline --abbrev-hash.

Signed-off-by: Roland Hieber <rhi@xxxxxxxxxxxxxx>
---
Changes in v1 -> v2:
 - add test
 - add documentation for git-config(1)
 - remove accidental whitespace change
---
 Documentation/config.txt        |  2 ++
 Documentation/config/reflog.txt |  5 +++++
 Documentation/git-reflog.txt    |  2 ++
 builtin/log.c                   | 11 ++++++++---
 t/t1410-reflog.sh               | 21 +++++++++++++++++++++
 5 files changed, 38 insertions(+), 3 deletions(-)
 create mode 100644 Documentation/config/reflog.txt

diff --git a/Documentation/config.txt b/Documentation/config.txt
index d87846faa..193c312fe 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -394,6 +394,8 @@ include::config/rebase.txt[]
 
 include::config/receive.txt[]
 
+include::config/reflog.txt[]
+
 include::config/remote.txt[]
 
 include::config/remotes.txt[]
diff --git a/Documentation/config/reflog.txt b/Documentation/config/reflog.txt
new file mode 100644
index 000000000..637cd852a
--- /dev/null
+++ b/Documentation/config/reflog.txt
@@ -0,0 +1,5 @@
+reflog.pretty::
+	The default pretty format used by linkgit:git-reflog[1] if nothing
+	else is specified via the `--pretty=` option.  If both are unset,
+	git-reflog falls back to `--pretty=oneline --abbrev-hash`.  See the
+	section Pretty Formats in linkgit:git-log[1] for possible values.
diff --git a/Documentation/git-reflog.txt b/Documentation/git-reflog.txt
index ff487ff77..9dccd4bcf 100644
--- a/Documentation/git-reflog.txt
+++ b/Documentation/git-reflog.txt
@@ -41,6 +41,8 @@ command-line (or `HEAD`, by default). The reflog covers all recent
 actions, and in addition the `HEAD` reflog records branch switching.
 `git reflog show` is an alias for `git log -g --abbrev-commit
 --pretty=oneline`; see linkgit:git-log[1] for more information.
+The config option `reflog.pretty` is used as the default pretty
+format if nothing else is specified.
 
 The "expire" subcommand prunes older reflog entries. Entries older
 than `expire` time, or entries older than `expire-unreachable` time
diff --git a/builtin/log.c b/builtin/log.c
index a479642eb..0592e5076 100644
--- a/builtin/log.c
+++ b/builtin/log.c
@@ -667,6 +667,7 @@ int cmd_log_reflog(int argc, const char **argv, const char *prefix)
 {
 	struct rev_info rev;
 	struct setup_revision_opt opt;
+	int cfg_have_pretty;
 
 	init_log_defaults();
 	git_config(git_log_config, NULL);
@@ -676,10 +677,14 @@ int cmd_log_reflog(int argc, const char **argv, const char *prefix)
 	rev.verbose_header = 1;
 	memset(&opt, 0, sizeof(opt));
 	opt.def = "HEAD";
+
+	cfg_have_pretty = git_config_get_string_const("reflog.pretty", &fmt_pretty);
 	cmd_log_init_defaults(&rev);
-	rev.abbrev_commit = 1;
-	rev.commit_format = CMIT_FMT_ONELINE;
-	rev.use_terminator = 1;
+	if (cfg_have_pretty != 0) {
+		rev.abbrev_commit = 1;
+		rev.commit_format = CMIT_FMT_ONELINE;
+		rev.use_terminator = 1;
+	}
 	rev.always_show_header = 1;
 	cmd_log_init_finish(argc, argv, prefix, &rev, &opt);
 
diff --git a/t/t1410-reflog.sh b/t/t1410-reflog.sh
index ae8a448e3..74abf3d0f 100755
--- a/t/t1410-reflog.sh
+++ b/t/t1410-reflog.sh
@@ -383,4 +383,25 @@ test_expect_success 'expire with multiple worktrees' '
 	)
 '
 
+test_expect_success '--pretty format' '
+	git init pretty-formats &&
+	(
+		cd pretty-formats &&
+		cat >expect <<-\EOF &&
+		HEAD@{0} commit (initial): foobar
+		EOF
+		test_tick &&
+		test_commit foobar &&
+
+		git reflog -n1 --pretty="%gD %gs" > output &&
+		test_cmp expect output &&
+
+		git -c reflog.pretty="%gD %gs" reflog -n1 > output &&
+		test_cmp expect output &&
+
+		git -c reflog.pretty="%h" reflog -n1 --pretty="%gD %gs" > output &&
+		test_cmp expect output
+	)
+'
+
 test_done
-- 
2.19.2