summaryrefslogtreecommitdiff
path: root/Documentation/pretty-formats.txt
diff options
context:
space:
mode:
authorDenton Liu <liu.denton@gmail.com>2019-11-20 00:51:25 (GMT)
committerJunio C Hamano <gitster@pobox.com>2019-11-20 04:33:37 (GMT)
commit1f0fc1db8599f87520494ca4f0e3c1b6fabdf997 (patch)
tree8d49fd7aa011a813f90e2dd9c4bc21648fe4b5e6 /Documentation/pretty-formats.txt
parent618a855083fbd3b8f9491ec8b32b39bdea91868d (diff)
downloadgit-1f0fc1db8599f87520494ca4f0e3c1b6fabdf997.zip
git-1f0fc1db8599f87520494ca4f0e3c1b6fabdf997.tar.gz
git-1f0fc1db8599f87520494ca4f0e3c1b6fabdf997.tar.bz2
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>
Diffstat (limited to 'Documentation/pretty-formats.txt')
-rw-r--r--Documentation/pretty-formats.txt11
1 files changed, 11 insertions, 0 deletions
diff --git a/Documentation/pretty-formats.txt b/Documentation/pretty-formats.txt
index 34bbc39..0df418e 100644
--- a/Documentation/pretty-formats.txt
+++ b/Documentation/pretty-formats.txt
@@ -63,6 +63,17 @@ This is designed to be as compact as possible.
<full commit message>
+* 'reference'
+
+ <abbrev hash> (<title line>, <short author date>)
++
+This format is used to refer to another commit in a commit message and
+is the same as `--pretty='format:%C(auto)%h (%s, %ad)'`. By default,
+the date is formatted with `--date=short` unless another `--date` option
+is explicitly specified. As with any `format:` with format
+placeholders, its output is not affected by other options like
+`--decorate` and `--walk-reflogs`.
+
* 'email'
From <hash> <date>