diff options
| author | Denton Liu <liu.denton@gmail.com> | 2019-11-19 16:51:25 -0800 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2019-11-20 13:33:37 +0900 |
| commit | 1f0fc1db8599f87520494ca4f0e3c1b6fabdf997 (patch) | |
| tree | 8d49fd7aa011a813f90e2dd9c4bc21648fe4b5e6 /Documentation/pretty-options.txt | |
| parent | 618a855083fbd3b8f9491ec8b32b39bdea91868d (diff) | |
| download | git-1f0fc1db8599f87520494ca4f0e3c1b6fabdf997.tar.gz | |
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-options.txt')
| -rw-r--r-- | Documentation/pretty-options.txt | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/Documentation/pretty-options.txt b/Documentation/pretty-options.txt index e44fc8f738..a59426eefd 100644 --- a/Documentation/pretty-options.txt +++ b/Documentation/pretty-options.txt @@ -3,7 +3,7 @@ Pretty-print the contents of the commit logs in a given format, where '<format>' can be one of 'oneline', 'short', 'medium', - 'full', 'fuller', 'email', 'raw', 'format:<string>' + 'full', 'fuller', 'reference', 'email', 'raw', 'format:<string>' and 'tformat:<string>'. When '<format>' is none of the above, and has '%placeholder' in it, it acts as if '--pretty=tformat:<format>' were given. |