From: Denton Liu <liu.denton@gmail.com>
To: Git Mailing List <git@vger.kernel.org>
Cc: "Eric Sunshine" <sunshine@sunshineco.com>,
"Junio C Hamano" <gitster@pobox.com>,
"René Scharfe" <l.s.r@web.de>,
"SZEDER Gábor" <szeder.dev@gmail.com>,
"Todd Zullinger" <tmz@pobox.com>
Subject: [PATCH v5 03/11] SubmittingPatches: remove dq from commit reference
Date: Tue, 19 Nov 2019 16:51:08 -0800 [thread overview]
Message-ID: <ff818446add361304fcd7a70eed300c407a408b3.1574211027.git.liu.denton@gmail.com> (raw)
In-Reply-To: <cover.1574211027.git.liu.denton@gmail.com>
Quoting SZEDER Gábor[1],
SubmittingPatches is simply wrong: our de-facto standard format for
referencing other commits does not enclose the subject in a pair of
double-quotes:
$ git log v2.24.0 |grep -E '[0-9a-f]{7} \("' |wc -l
785
$ git log v2.24.0 |grep -E '[0-9a-f]{7} \([^"]' |wc -l
2276
Those double-quotes don't add any value to the references, but they
result in weird looking references for 1083 of our commits whose
subject lines happen to end with double-quotes, e.g.:
f23a465132 ("hashmap_get{,_from_hash} return "struct hashmap_entry *"", 2019-10-06)
and without those unnecessary pair of double-quotes we would have
~3000 more commits whose summary would fit on a single line.
Remove references to the enclosing double-quotes from SubmittingPatches
since our de-facto standard for referencing commits does not actually
use them.
[1]: cf. <20191114011048.GS4348@szeder.dev>
Signed-off-by: Denton Liu <liu.denton@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
---
Documentation/SubmittingPatches | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index 5a00329d5a..a1aad13384 100644
--- a/Documentation/SubmittingPatches
+++ b/Documentation/SubmittingPatches
@@ -142,19 +142,19 @@ archive, summarize the relevant points of the discussion.
[[commit-reference]]
If you want to reference a previous commit in the history of a stable
-branch, use the format "abbreviated hash (subject, date)",
-with the subject enclosed in a pair of double-quotes, like this:
+branch, use the format "abbreviated hash (subject, date)", like this:
....
- Commit f86a374 ("pack-bitmap.c: fix a memleak", 2015-03-30)
+ Commit f86a374 (pack-bitmap.c: fix a memleak, 2015-03-30)
noticed that ...
....
The "Copy commit summary" command of gitk can be used to obtain this
-format, or this invocation of `git show`:
+format (with the subject enclosed in a pair of double-quotes), or this
+invocation of `git show`:
....
- git show -s --date=short --pretty='format:%h ("%s", %ad)' <commit>
+ git show -s --date=short --pretty='format:%h (%s, %ad)' <commit>
....
[[git-tools]]
--
2.24.0.420.g9ac4901264
next prev parent reply other threads:[~2019-11-20 0:51 UTC|newest]
Thread overview: 81+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-11-04 20:03 [PATCH 0/8] learn the "summary" pretty format Denton Liu
2019-11-04 20:03 ` [PATCH 1/8] pretty-formats.txt: use generic terms for hash Denton Liu
2019-11-04 20:03 ` [PATCH 2/8] revision: make get_revision_mark() return const pointer Denton Liu
2019-11-04 20:03 ` [PATCH 3/8] revision: change abbrev_commit_given to abbrev_commit_explicit Denton Liu
2019-11-04 20:03 ` [PATCH 4/8] pretty.c: inline initalize format_context Denton Liu
2019-11-04 20:03 ` [PATCH 5/8] pretty.c: extract functionality to repo_format_commit_generic() Denton Liu
2019-11-04 20:04 ` [PATCH 6/8] reflog-walk.c: don't print last newline with oneline Denton Liu
2019-11-06 5:12 ` Junio C Hamano
2019-11-08 8:50 ` Denton Liu
2019-11-04 20:04 ` [PATCH 7/8] pretty: implement 'summary' format Denton Liu
2019-11-04 20:16 ` Eric Sunshine
2019-11-04 20:35 ` Denton Liu
2019-11-04 20:38 ` Eric Sunshine
2019-11-04 20:45 ` Denton Liu
2019-11-04 20:04 ` [PATCH 8/8] SubmittingPatches: use `--pretty=summary` Denton Liu
2019-11-08 20:08 ` [PATCH v2 00/10] learn the "summary" pretty format Denton Liu
2019-11-08 20:08 ` [PATCH v2 01/10] SubmittingPatches: use generic terms for hash Denton Liu
2019-11-08 20:08 ` [PATCH v2 02/10] pretty-formats.txt: " Denton Liu
2019-11-08 20:08 ` [PATCH v2 03/10] revision: make get_revision_mark() return const pointer Denton Liu
2019-11-08 20:08 ` [PATCH v2 04/10] revision: change abbrev_commit_given to abbrev_commit_explicit Denton Liu
2019-11-08 20:08 ` [PATCH v2 05/10] pretty.c: inline initalize format_context Denton Liu
2019-11-08 20:08 ` [PATCH v2 06/10] pretty.c: extract functionality to repo_format_commit_generic() Denton Liu
2019-11-08 20:08 ` [PATCH v2 07/10] t4205: cover `git log --reflog -z` blindspot Denton Liu
2019-11-08 20:36 ` Eric Sunshine
2019-11-08 21:47 ` Denton Liu
2019-11-08 21:58 ` Eric Sunshine
2019-11-08 20:08 ` [PATCH v2 08/10] reflog-walk.c: move where the newline is added Denton Liu
2019-11-08 20:08 ` [PATCH v2 09/10] pretty: implement 'summary' format Denton Liu
2019-11-08 20:46 ` Eric Sunshine
2019-11-09 6:38 ` René Scharfe
2019-11-10 6:25 ` Junio C Hamano
2019-11-11 23:47 ` Denton Liu
2019-11-14 0:37 ` SZEDER Gábor
2019-11-14 2:44 ` Junio C Hamano
2019-11-09 6:38 ` René Scharfe
2019-11-14 1:10 ` SZEDER Gábor
2019-11-08 20:08 ` [PATCH v2 10/10] SubmittingPatches: use `--pretty=summary` Denton Liu
2019-11-14 20:47 ` [PATCH v3 00/10] learn the "reference" pretty format Denton Liu
2019-11-14 20:47 ` [PATCH v3 01/10] SubmittingPatches: use generic terms for hash Denton Liu
2019-11-14 20:47 ` [PATCH v3 02/10] pretty-formats.txt: " Denton Liu
2019-11-14 20:47 ` [PATCH v3 03/10] SubmittingPatches: remove dq from commit reference Denton Liu
2019-11-14 20:47 ` [PATCH v3 04/10] completion: complete `tformat:` pretty format Denton Liu
2019-11-14 20:47 ` [PATCH v3 05/10] revision: make get_revision_mark() return const pointer Denton Liu
2019-11-14 20:47 ` [PATCH v3 06/10] pretty.c: inline initalize format_context Denton Liu
2019-11-14 20:47 ` [PATCH v3 07/10] t4205: cover `git log --reflog -z` blindspot Denton Liu
2019-11-14 20:47 ` [PATCH v3 08/10] pretty: provide short date format Denton Liu
2019-11-14 20:47 ` [PATCH v3 09/10] pretty: implement 'reference' format Denton Liu
2019-11-15 3:33 ` Todd Zullinger
2019-11-15 6:07 ` Junio C Hamano
2019-11-15 13:18 ` SZEDER Gábor
2019-11-16 1:46 ` Junio C Hamano
2019-11-18 1:44 ` Junio C Hamano
2019-11-18 1:42 ` Junio C Hamano
2019-11-15 8:07 ` Eric Sunshine
2019-11-14 20:47 ` [PATCH v3 10/10] SubmittingPatches: use `--pretty=reference` Denton Liu
2019-11-19 0:21 ` [PATCH v4 00/11] learn the "reference" pretty format Denton Liu
2019-11-19 0:21 ` [PATCH v4 01/11] SubmittingPatches: use generic terms for hash Denton Liu
2019-11-19 0:21 ` [PATCH v4 02/11] pretty-formats.txt: " Denton Liu
2019-11-19 0:21 ` [PATCH v4 03/11] SubmittingPatches: remove dq from commit reference Denton Liu
2019-11-19 0:21 ` [PATCH v4 04/11] completion: complete `tformat:` pretty format Denton Liu
2019-11-19 0:21 ` [PATCH v4 05/11] revision: make get_revision_mark() return const pointer Denton Liu
2019-11-19 0:21 ` [PATCH v4 06/11] pretty.c: inline initalize format_context Denton Liu
2019-11-19 0:21 ` [PATCH v4 07/11] t4205: cover `git log --reflog -z` blindspot Denton Liu
2019-11-19 0:21 ` [PATCH v4 08/11] pretty: provide short date format Denton Liu
2019-11-19 0:21 ` [PATCH v4 09/11] pretty: implement 'reference' format Denton Liu
2019-11-19 0:21 ` [PATCH v4 10/11] SubmittingPatches: use `--pretty=reference` Denton Liu
2019-11-19 0:21 ` [PATCH v4 11/11] squash! pretty: implement 'reference' format Denton Liu
2019-11-19 3:10 ` Junio C Hamano
2019-11-20 0:51 ` [PATCH v5 00/11] learn the "reference" pretty format Denton Liu
2019-11-20 0:51 ` [PATCH v5 01/11] SubmittingPatches: use generic terms for hash Denton Liu
2019-11-20 0:51 ` [PATCH v5 02/11] pretty-formats.txt: " Denton Liu
2019-11-20 0:51 ` Denton Liu [this message]
2019-11-20 0:51 ` [PATCH v5 04/11] completion: complete `tformat:` pretty format Denton Liu
2019-11-20 0:51 ` [PATCH v5 05/11] revision: make get_revision_mark() return const pointer Denton Liu
2019-11-20 0:51 ` [PATCH v5 06/11] pretty.c: inline initalize format_context Denton Liu
2019-11-20 0:51 ` [PATCH v5 07/11] t4205: cover `git log --reflog -z` blindspot Denton Liu
2019-11-20 0:51 ` [PATCH v5 08/11] pretty: provide short date format Denton Liu
2019-11-20 0:51 ` [PATCH v5 09/11] pretty: add struct cmt_fmt_map::default_date_mode_type Denton Liu
2019-11-20 3:15 ` Junio C Hamano
2019-11-20 0:51 ` [PATCH v5 10/11] pretty: implement 'reference' format Denton Liu
2019-11-20 0:51 ` [PATCH v5 11/11] SubmittingPatches: use `--pretty=reference` Denton Liu
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=ff818446add361304fcd7a70eed300c407a408b3.1574211027.git.liu.denton@gmail.com \
--to=liu.denton@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=l.s.r@web.de \
--cc=sunshine@sunshineco.com \
--cc=szeder.dev@gmail.com \
--cc=tmz@pobox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).