kernel
/
git
mirror of https://git.kernel.org/pub/scm/git/git.git
1
0
Fork 0
Code Releases Activity

SubmittingPatches: remove dq from commit reference 

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>
maint
Denton Liu 2019-11-19 16:51:08 -08:00 committed by Junio C Hamano
parent bae74c9dfb
commit fb2ffa77a6
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
Documentation/SubmittingPatches
View File

@ -142,19 +142,19 @@ archive, summarize the relevant points of the discussion.


[[commit-reference]] [[commit-reference]]
If you want to reference a previous commit in the history of a stable If you want to reference a previous commit in the history of a stable
branch, use the format "abbreviated hash (subject, date)", branch, use the format "abbreviated hash (subject, date)", like this:
with the subject enclosed in a pair of double-quotes, 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 ... noticed that ...
.... ....


The "Copy commit summary" command of gitk can be used to obtain this 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]] [[git-tools]]