{"thread":{"id":"43940","subject":"[PATCH] Documentation/SubmittingPatches: add quotes to advised commit reference","startedAt":"2016-08-26T22:27:26Z","lastAt":"2016-08-29T18:18:16Z","messageCount":6,"participants":["Stefan Beller","Junio C Hamano","Jakub Narębski","Michael J Gruber"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"300310","messageId":"20160826222714.31459-1-sbeller@google.com","threadId":"43940","inReplyTo":null,"subject":"[PATCH] Documentation/SubmittingPatches: add quotes to advised commit reference","fromName":"Stefan Beller","fromEmail":"sbeller@google.com","sentAt":"2016-08-26T22:27:14Z","receivedAt":"2016-08-26T22:27:26Z","isPatch":true,"sender":{"key":"stefanbeller@gmail.com","avatar":"https://avatars.githubusercontent.com/u/455868?v=4"},"body":"Junio finds it is easier to read text when the commit subject is quoted.\n\nSigned-off-by: Stefan Beller \n---\n Documentation/SubmittingPatches | 2 +-\n 1 file changed, 1 insertion(+), 1 deletion(-)\n\ndiff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches\nindex 500230c..a591229 100644\n--- a/Documentation/SubmittingPatches\n+++ b/Documentation/SubmittingPatches\n@@ -123,7 +123,7 @@ archive, summarize the relevant points of the discussion.\n \n If you want to reference a previous commit in the history of a stable\n branch use the format \"abbreviated sha1 (subject, date)\". So for example\n-like this: \"Commit f86a374 (pack-bitmap.c: fix a memleak, 2015-03-30)\n+like this: \"Commit f86a374 (\"pack-bitmap.c: fix a memleak\", 2015-03-30)\n noticed [...]\".\n \n \n-- \n2.10.0.rc1.1.g1ceb01a\n\n"},{"id":"300313","messageId":"xmqqk2f3duf2.fsf@gitster.mtv.corp.google.com","threadId":"43940","inReplyTo":"20160826222714.31459-1-sbeller@google.com","subject":"Re: [PATCH] Documentation/SubmittingPatches: add quotes to advised commit reference","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2016-08-26T22:42:09Z","receivedAt":"2016-08-26T22:42:17Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Stefan Beller writes:\n\n> Junio finds it is easier to read text when the commit subject is quoted.\n>\n> Signed-off-by: Stefan Beller \n> ---\n> Documentation/SubmittingPatches | 2 +-\n> 1 file changed, 1 insertion(+), 1 deletion(-)\n>\n> diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches\n> index 500230c..a591229 100644\n> --- a/Documentation/SubmittingPatches\n> +++ b/Documentation/SubmittingPatches\n> @@ -123,7 +123,7 @@ archive, summarize the relevant points of the discussion.\n> \n> If you want to reference a previous commit in the history of a stable\n> branch use the format \"abbreviated sha1 (subject, date)\". So for example\n> -like this: \"Commit f86a374 (pack-bitmap.c: fix a memleak, 2015-03-30)\n> +like this: \"Commit f86a374 (\"pack-bitmap.c: fix a memleak\", 2015-03-30)\n> noticed [...]\".\n\nThanks, but it is not sufficient as you would not see the need for\nquoting without the example.\n\nMy preference is not a main deciding factor in this case anyway. A\nmore important reason why it makes sense to quote (aside from the\nfact that it makes more sense when reading) is because we already\nhave a tool support for that.\n\nPerhaps something like this instead?\n\n-- >8 --\nFrom: Beat Bolli \nSubject: SubmittingPatches: use gitk's \"Copy commit summary\" format\nDate: Fri, 26 Aug 2016 18:59:01 +0200\n\nUpdate the suggestion in 175d38ca (\"SubmittingPatches: document how\nto reference previous commits\", 2016-07-28) on the format to refer\nto a commit to match what gitk has been giving since last year with\nits \"Copy commit summary\" command; also mention this as one of the\nways to obtain a commit reference in this format.\n\nSigned-off-by: Beat Bolli \n---\n Documentation/SubmittingPatches | 11 ++++++++---\n 1 file changed, 8 insertions(+), 3 deletions(-)\n\ndiff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches\nindex 500230c..15adb86 100644\n--- a/Documentation/SubmittingPatches\n+++ b/Documentation/SubmittingPatches\n@@ -122,9 +122,14 @@ without external resources. Instead of giving a URL to a mailing list\n archive, summarize the relevant points of the discussion.\n \n If you want to reference a previous commit in the history of a stable\n-branch use the format \"abbreviated sha1 (subject, date)\". So for example\n-like this: \"Commit f86a374 (pack-bitmap.c: fix a memleak, 2015-03-30)\n-noticed [...]\".\n+branch, use the format \"abbreviated sha1 (subject, date)\",\n+with the subject enclosed in a pair of double-quotes, like this:\n+\n+ Commit f86a374 (\"pack-bitmap.c: fix a memleak\", 2015-03-30)\n+ noticed that ...\n+\n+The \"Copy commit summary\" command of gitk can be used to obtain this\n+format.\n \n \n (3) Generate your patch using Git tools out of your commits.\n"},{"id":"300314","messageId":"CAGZ79kag07E_n+4KjOqqv-mxLe0T1VYjnuu5mT1k_EXLBcaYvQ@mail.gmail.com","threadId":"43940","inReplyTo":"xmqqk2f3duf2.fsf@gitster.mtv.corp.google.com","subject":"Re: [PATCH] Documentation/SubmittingPatches: add quotes to advised commit reference","fromName":"Stefan Beller","fromEmail":"sbeller@google.com","sentAt":"2016-08-26T22:45:57Z","receivedAt":"2016-08-26T22:46:02Z","isPatch":true,"sender":{"key":"stefanbeller@gmail.com","avatar":"https://avatars.githubusercontent.com/u/455868?v=4"},"body":"On Fri, Aug 26, 2016 at 3:42 PM, Junio C Hamano wrote:\n>\n> Perhaps something like this instead?\n>\n> -- >8 --\n\nThis is way better.\nLet's take that.\n\nThanks,\nStefan\n\n> From: Beat Bolli \n> Subject: SubmittingPatches: use gitk's \"Copy commit summary\" format\n> Date: Fri, 26 Aug 2016 18:59:01 +0200\n>\n> Update the suggestion in 175d38ca (\"SubmittingPatches: document how\n> to reference previous commits\", 2016-07-28) on the format to refer\n> to a commit to match what gitk has been giving since last year with\n> its \"Copy commit summary\" command; also mention this as one of the\n> ways to obtain a commit reference in this format.\n>\n> Signed-off-by: Beat Bolli \n> ---\n> Documentation/SubmittingPatches | 11 ++++++++---\n> 1 file changed, 8 insertions(+), 3 deletions(-)\n>\n> diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches\n> index 500230c..15adb86 100644\n> --- a/Documentation/SubmittingPatches\n> +++ b/Documentation/SubmittingPatches\n> @@ -122,9 +122,14 @@ without external resources. Instead of giving a URL to a mailing list\n> archive, summarize the relevant points of the discussion.\n>\n> If you want to reference a previous commit in the history of a stable\n> -branch use the format \"abbreviated sha1 (subject, date)\". So for example\n> -like this: \"Commit f86a374 (pack-bitmap.c: fix a memleak, 2015-03-30)\n> -noticed [...]\".\n> +branch, use the format \"abbreviated sha1 (subject, date)\",\n> +with the subject enclosed in a pair of double-quotes, like this:\n> +\n> + Commit f86a374 (\"pack-bitmap.c: fix a memleak\", 2015-03-30)\n> + noticed that ...\n> +\n> +The \"Copy commit summary\" command of gitk can be used to obtain this\n> +format.\n>\n>\n> (3) Generate your patch using Git tools out of your commits.\n"},{"id":"300326","messageId":"0a480dd8-186f-8411-3f9b-371a4628b342@gmail.com","threadId":"43940","inReplyTo":"xmqqk2f3duf2.fsf@gitster.mtv.corp.google.com","subject":"Re: [PATCH] Documentation/SubmittingPatches: add quotes to advised commit reference","fromName":"Jakub Narębski","fromEmail":"jnareb@gmail.com","sentAt":"2016-08-27T08:04:02Z","receivedAt":"2016-08-27T08:04:17Z","isPatch":true,"sender":{"key":"jnareb@gmail.com","avatar":"https://avatars.githubusercontent.com/u/2706?v=4"},"body":"W dniu 27.08.2016 o 00:42, Junio C Hamano pisze:\n> Stefan Beller writes:\n\n> -- >8 --\n> From: Beat Bolli \n\n???\n"},{"id":"300454","messageId":"389d314d-5f68-b195-3268-4234440ca4ba@drmicha.warpmail.net","threadId":"43940","inReplyTo":"xmqqk2f3duf2.fsf@gitster.mtv.corp.google.com","subject":"Re: [PATCH] Documentation/SubmittingPatches: add quotes to advised commit reference","fromName":"Michael J Gruber","fromEmail":"git@drmicha.warpmail.net","sentAt":"2016-08-29T11:24:28Z","receivedAt":"2016-08-29T11:24:37Z","isPatch":true,"sender":{"key":"git@grubix.eu","avatar":"https://avatars.githubusercontent.com/u/233215?v=4"},"body":"Junio C Hamano venit, vidit, dixit 27.08.2016 00:42:\n> Stefan Beller writes:\n> \n>> Junio finds it is easier to read text when the commit subject is quoted.\n>>\n>> Signed-off-by: Stefan Beller \n>> ---\n>> Documentation/SubmittingPatches | 2 +-\n>> 1 file changed, 1 insertion(+), 1 deletion(-)\n>>\n>> diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches\n>> index 500230c..a591229 100644\n>> --- a/Documentation/SubmittingPatches\n>> +++ b/Documentation/SubmittingPatches\n>> @@ -123,7 +123,7 @@ archive, summarize the relevant points of the discussion.\n>> \n>> If you want to reference a previous commit in the history of a stable\n>> branch use the format \"abbreviated sha1 (subject, date)\". So for example\n>> -like this: \"Commit f86a374 (pack-bitmap.c: fix a memleak, 2015-03-30)\n>> +like this: \"Commit f86a374 (\"pack-bitmap.c: fix a memleak\", 2015-03-30)\n>> noticed [...]\".\n> \n> Thanks, but it is not sufficient as you would not see the need for\n> quoting without the example.\n> \n> My preference is not a main deciding factor in this case anyway. A\n> more important reason why it makes sense to quote (aside from the\n> fact that it makes more sense when reading) is because we already\n> have a tool support for that.\n> \n> Perhaps something like this instead?\n> \n> -- >8 --\n> From: Beat Bolli \n> Subject: SubmittingPatches: use gitk's \"Copy commit summary\" format\n> Date: Fri, 26 Aug 2016 18:59:01 +0200\n> \n> Update the suggestion in 175d38ca (\"SubmittingPatches: document how\n> to reference previous commits\", 2016-07-28) on the format to refer\n> to a commit to match what gitk has been giving since last year with\n> its \"Copy commit summary\" command; also mention this as one of the\n> ways to obtain a commit reference in this format.\n> \n> Signed-off-by: Beat Bolli \n> ---\n> Documentation/SubmittingPatches | 11 ++++++++---\n> 1 file changed, 8 insertions(+), 3 deletions(-)\n> \n> diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches\n> index 500230c..15adb86 100644\n> --- a/Documentation/SubmittingPatches\n> +++ b/Documentation/SubmittingPatches\n> @@ -122,9 +122,14 @@ without external resources. Instead of giving a URL to a mailing list\n> archive, summarize the relevant points of the discussion.\n> \n> If you want to reference a previous commit in the history of a stable\n> -branch use the format \"abbreviated sha1 (subject, date)\". So for example\n> -like this: \"Commit f86a374 (pack-bitmap.c: fix a memleak, 2015-03-30)\n> -noticed [...]\".\n> +branch, use the format \"abbreviated sha1 (subject, date)\",\n> +with the subject enclosed in a pair of double-quotes, like this:\n> +\n> + Commit f86a374 (\"pack-bitmap.c: fix a memleak\", 2015-03-30)\n> + noticed that ...\n> +\n> +The \"Copy commit summary\" command of gitk can be used to obtain this\n> +format.\n\nor (an alias for) the command\n\ngit show -s --date=format:%F --pretty='tformat:%h (\"%s\", %ad)'\n\n> \n> (3) Generate your patch using Git tools out of your commits.\n> \n\n"},{"id":"300479","messageId":"xmqqlgzfbfrz.fsf@gitster.mtv.corp.google.com","threadId":"43940","inReplyTo":"0a480dd8-186f-8411-3f9b-371a4628b342@gmail.com","subject":"Re: [PATCH] Documentation/SubmittingPatches: add quotes to advised commit reference","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2016-08-29T18:18:08Z","receivedAt":"2016-08-29T18:18:16Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Jakub Narębski writes:\n\n> W dniu 27.08.2016 o 00:42, Junio C Hamano pisze:\n>> Stefan Beller writes:\n>\n>> -- >8 --\n>> From: Beat Bolli \n>\n> ???\n\nThe primary value the change adds is to make readers aware of the\ngitk feature. That comes from the primary author. Not something I\nadded, Stefan added or Heiko added.\n"}]}