[PATCH v2 10/10] SubmittingPatches: use `--pretty=summary`
Git Mailing List
Eric Sunshine
Junio C Hamano
Denton Liu
See Also
Prev Ref 1
2019-11-08 20:08:37 UTC
Since Git was taught the `--pretty=summary` option, it is no longer
necessary to manually specify the format string to get the commit
summary. Teach users to use the new option while keeping the old
invocation around in case they have an older version of Git.

Signed-off-by: Denton Liu <liu.denton@gmail.com>
 Documentation/SubmittingPatches | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index bb7e33ce15..849d27663e 100644
--- a/Documentation/SubmittingPatches
+++ b/Documentation/SubmittingPatches
@@ -153,6 +153,12 @@ with the subject enclosed in a pair of double-quotes, like this:
 The "Copy commit summary" command of gitk can be used to obtain this
 format, or this invocation of `git show`:
+	git show -s --pretty=summary <commit>
+or, on an older version of Git without support for --pretty=summary:
 	git show -s --date=short --pretty='format:%h ("%s", %ad)' <commit>