pretty: implement 'reference' format
The standard format for referencing other commits within some projects (such as git.git) is the reference format. This is described in Documentation/SubmittingPatches as If you want to reference a previous commit in the history of a stable branch, use the format "abbreviated hash (subject, date)", like this: .... Commit f86a374 (pack-bitmap.c: fix a memleak, 2015-03-30) noticed that ... .... Since this format is so commonly used, standardize it as a pretty format. The tests that are implemented essentially show that the format-string does not change in response to various log options. This is useful because, for future developers, it shows that we've considered the limitations of the "canned format-string" approach and we are fine with them. Based-on-a-patch-by: SZEDER Gábor <szeder.dev@gmail.com> Signed-off-by: Denton Liu <liu.denton@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Denton Liu committed
Nov 19, 2019 at 16:51 UTC
1f0fc1db8599f87520494ca4f0e3c1b6fabdf997
6 files changed
+62
-4
Documentation/pretty-formats.txt
+11
@@ -63,6 +63,17 @@ This is designed to be as compact as possible.
63
64
<full commit message>
65
66
+* 'reference'
67
+
68
+ <abbrev hash> (<title line>, <short author date>)
69
++
70
+This format is used to refer to another commit in a commit message and
71
+is the same as `--pretty='format:%C(auto)%h (%s, %ad)'`. By default,
72
+the date is formatted with `--date=short` unless another `--date` option
73
+is explicitly specified. As with any `format:` with format
74
+placeholders, its output is not affected by other options like
75
+`--decorate` and `--walk-reflogs`.
76
+
77
* 'email'
78
79
From <hash> <date>
Documentation/pretty-options.txt
+1
-1
@@ -3,7 +3,7 @@
3
4
Pretty-print the contents of the commit logs in a given format,
5
where '<format>' can be one of 'oneline', 'short', 'medium',
6
- 'full', 'fuller', 'email', 'raw', 'format:<string>'
6
+ 'full', 'fuller', 'reference', 'email', 'raw', 'format:<string>'
7
and 'tformat:<string>'. When '<format>' is none of the above,
8
and has '%placeholder' in it, it acts as if
9
'--pretty=tformat:<format>' were given.
Documentation/rev-list-options.txt
+3
-1
@@ -269,7 +269,7 @@ list.
269
exclude (that is, '{caret}commit', 'commit1..commit2',
270
and 'commit1\...commit2' notations cannot be used).
271
+
272
-With `--pretty` format other than `oneline` (for obvious reasons),
272
+With `--pretty` format other than `oneline` and `reference` (for obvious reasons),
273
this causes the output to have two extra lines of information
274
taken from the reflog. The reflog designator in the output may be shown
275
as `ref@{Nth}` (where `Nth` is the reverse-chronological index in the
@@ -293,6 +293,8 @@ Under `--pretty=oneline`, the commit message is
293
prefixed with this information on the same line.
294
This option cannot be combined with `--reverse`.
295
See also linkgit:git-reflog[1].
296
++
297
+Under `--pretty=reference`, this information will not be shown at all.
298
299
--merge::
300
After a failed merge, show refs that touch files having a
contrib/completion/git-completion.bash
+1
-1
@@ -1737,7 +1737,7 @@ __git_log_shortlog_options="
1737
--all-match --invert-grep
1738
"
1739
1740
-__git_log_pretty_formats="oneline short medium full fuller email raw format: tformat: mboxrd"
1740
+__git_log_pretty_formats="oneline short medium full fuller reference email raw format: tformat: mboxrd"
1741
__git_log_date_formats="relative iso8601 iso8601-strict rfc2822 short local default raw unix format:"
1742
1743
_git_log ()
pretty.c
+3
-1
@@ -98,7 +98,9 @@ static void setup_commit_formats(void)
98
{ "mboxrd", CMIT_FMT_MBOXRD, 0, 0 },
99
{ "fuller", CMIT_FMT_FULLER, 0, 8 },
100
{ "full", CMIT_FMT_FULL, 0, 8 },
101
- { "oneline", CMIT_FMT_ONELINE, 1, 0 }
101
+ { "oneline", CMIT_FMT_ONELINE, 1, 0 },
102
+ { "reference", CMIT_FMT_USERFORMAT, 1, 0,
103
+ 0, DATE_SHORT, "%C(auto)%h (%s, %ad)" },
104
/*
105
* Please update $__git_log_pretty_formats in
106
* git-completion.bash when you add new formats.
t/t4205-log-pretty-formats.sh
+43
@@ -824,4 +824,47 @@ test_expect_success '%S in git log --format works with other placeholders (part
824
test_cmp expect actual
825
'
826
827
+test_expect_success 'log --pretty=reference' '
828
+ git log --pretty="tformat:%h (%s, %as)" >expect &&
829
+ git log --pretty=reference >actual &&
830
+ test_cmp expect actual
831
+'
832
+
833
+test_expect_success 'log --pretty=reference with log.date is overridden by short date' '
834
+ git log --pretty="tformat:%h (%s, %as)" >expect &&
835
+ test_config log.date rfc &&
836
+ git log --pretty=reference >actual &&
837
+ test_cmp expect actual
838
+'
839
+
840
+test_expect_success 'log --pretty=reference with explicit date overrides short date' '
841
+ git log --date=rfc --pretty="tformat:%h (%s, %ad)" >expect &&
842
+ git log --date=rfc --pretty=reference >actual &&
843
+ test_cmp expect actual
844
+'
845
+
846
+test_expect_success 'log --pretty=reference is never unabbreviated' '
847
+ git log --pretty="tformat:%h (%s, %as)" >expect &&
848
+ git log --no-abbrev-commit --pretty=reference >actual &&
849
+ test_cmp expect actual
850
+'
851
+
852
+test_expect_success 'log --pretty=reference is never decorated' '
853
+ git log --pretty="tformat:%h (%s, %as)" >expect &&
854
+ git log --decorate=short --pretty=reference >actual &&
855
+ test_cmp expect actual
856
+'
857
+
858
+test_expect_success 'log --pretty=reference does not output reflog info' '
859
+ git log --walk-reflogs --pretty="tformat:%h (%s, %as)" >expect &&
860
+ git log --walk-reflogs --pretty=reference >actual &&
861
+ test_cmp expect actual
862
+'
863
+
864
+test_expect_success 'log --pretty=reference is colored appropriately' '
865
+ git log --color=always --pretty="tformat:%C(auto)%h (%s, %as)" >expect &&
866
+ git log --color=always --pretty=reference >actual &&
867
+ test_cmp expect actual
868
+'
869
+
870
test_done