{"thread":{"id":"43938","subject":"[PATCH 2/2] SubmittingPatches: hint at gitk's \"Copy commit summary\" command","startedAt":"2016-08-26T17:05:50Z","lastAt":"2016-08-29T18:30:25Z","messageCount":12,"participants":["Beat Bolli","Junio C Hamano","Stefan Beller","Jacob Keller","Johannes Sixt","Jeff King"],"isPatch":true,"patchVersion":1,"patchTotal":2},"messages":[{"id":"300266","messageId":"1472230741-5161-2-git-send-email-dev+git@drbeat.li","threadId":"43938","inReplyTo":"1472230741-5161-1-git-send-email-dev+git@drbeat.li","subject":"[PATCH 2/2] SubmittingPatches: hint at gitk's \"Copy commit summary\" command","fromName":"Beat Bolli","fromEmail":"dev+git@drbeat.li","sentAt":"2016-08-26T16:59:01Z","receivedAt":"2016-08-26T17:05:50Z","isPatch":true,"sender":{"key":"dev+git@drbeat.li","avatar":"https://avatars.githubusercontent.com/u/21444?v=4"},"body":"Amend the section on referencing previous commits with a hint to the\ngitk command that was added exactly for this purpose.\n\nSigned-off-by: Beat Bolli \n---\n Documentation/SubmittingPatches | 3 ++-\n 1 file changed, 2 insertions(+), 1 deletion(-)\n\ndiff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches\nindex 500230c..94a1661 100644\n--- a/Documentation/SubmittingPatches\n+++ b/Documentation/SubmittingPatches\n@@ -124,7 +124,8 @@ archive, summarize the relevant points of the discussion.\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+noticed [...]\". The \"Copy commit summary\" command of gitk generates this\n+format.\n \n \n (3) Generate your patch using Git tools out of your commits.\n-- \n2.7.2\n"},{"id":"300267","messageId":"1472230741-5161-1-git-send-email-dev+git@drbeat.li","threadId":"43938","inReplyTo":null,"subject":"[PATCH 1/2] gitk: align the commit summary format to the documentation","fromName":"Beat Bolli","fromEmail":"dev+git@drbeat.li","sentAt":"2016-08-26T16:59:00Z","receivedAt":"2016-08-26T17:05:54Z","isPatch":true,"sender":{"key":"dev+git@drbeat.li","avatar":"https://avatars.githubusercontent.com/u/21444?v=4"},"body":"In 175d38c (SubmittingPatches: document how to reference previous commits,\n2016-07-28) the format for referring to older commits was specified.\n\nMake the text generated by the \"Copy commit summary\" command match this\nformat.\n\nSigned-off-by: Beat Bolli \nCc: Paul Mackerras \n---\n gitk-git/gitk | 2 +-\n 1 file changed, 1 insertion(+), 1 deletion(-)\n\ndiff --git a/gitk-git/gitk b/gitk-git/gitk\nindex 805a1c7..a27bf99 100755\n--- a/gitk-git/gitk\n+++ b/gitk-git/gitk\n@@ -9382,7 +9382,7 @@ proc mktaggo {} {\n proc copysummary {} {\n global rowmenuid autosellen\n \n- set format \"%h (\\\"%s\\\", %ad)\"\n+ set format \"%h (%s, %ad)\"\n set cmd [list git show -s --pretty=format:$format --date=short]\n if {$autosellen < 40} {\n lappend cmd --abbrev=$autosellen\n-- \n2.7.2\n"},{"id":"300282","messageId":"xmqqoa4fgzhv.fsf@gitster.mtv.corp.google.com","threadId":"43938","inReplyTo":"1472230741-5161-1-git-send-email-dev+git@drbeat.li","subject":"Re: [PATCH 1/2] gitk: align the commit summary format to the documentation","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2016-08-26T18:24:12Z","receivedAt":"2016-08-26T18:24:59Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Beat Bolli writes:\n\n> In 175d38c (SubmittingPatches: document how to reference previous commits,\n> 2016-07-28) the format for referring to older commits was specified.\n>\n> Make the text generated by the \"Copy commit summary\" command match this\n> format.\n\nHmph. I didn't know gitk already had its own command to produce a\nshort string. I actually think what it produces\n\n> In 175d38c (\"SubmittingPatches: document how to reference previous commits\",\n> 2016-07-28) the format for referring to older commits was specified.\n\nis easier to read when pasted into a sentence than what the recent\nupdate 175d38ca (\"SubmittingPatches: document how to reference\nprevious commits\", 2016-07-28) suggests to do, i.e.\n\n> In 175d38c (SubmittingPatches: document how to reference previous commits,\n> 2016-07-28) the format for referring to older commits was specified.\n\nHeiko, Stefan, I think you two were involved in adding that new\nparagraph. What do you think?\n"},{"id":"300284","messageId":"xmqqk2f3gzcm.fsf@gitster.mtv.corp.google.com","threadId":"43938","inReplyTo":"1472230741-5161-2-git-send-email-dev+git@drbeat.li","subject":"Re: [PATCH 2/2] SubmittingPatches: hint at gitk's \"Copy commit summary\" command","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2016-08-26T18:27:21Z","receivedAt":"2016-08-26T18:27:28Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Beat Bolli writes:\n\n> @@ -124,7 +124,8 @@ archive, summarize the relevant points of the discussion.\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> +noticed [...]\". The \"Copy commit summary\" command of gitk generates this\n> +format.\n\n(continuing from my 1/2 review) And if people agree that the format\ngitk already uses is better, this text should probably read more\nlike:\n\n If you want to reference a previous commit in the history of a\n stable 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"},{"id":"300287","messageId":"CAGZ79kbL13b=iZiFKW8a=G+2zXRSwjYDTzu2TS47Ppohgzm0Gg@mail.gmail.com","threadId":"43938","inReplyTo":"xmqqoa4fgzhv.fsf@gitster.mtv.corp.google.com","subject":"Re: [PATCH 1/2] gitk: align the commit summary format to the documentation","fromName":"Stefan Beller","fromEmail":"sbeller@google.com","sentAt":"2016-08-26T19:16:23Z","receivedAt":"2016-08-26T19:16:29Z","isPatch":true,"sender":{"key":"stefanbeller@gmail.com","avatar":"https://avatars.githubusercontent.com/u/455868?v=4"},"body":"On Fri, Aug 26, 2016 at 11:24 AM, Junio C Hamano wrote:\n> Beat Bolli writes:\n>\n>> In 175d38c (SubmittingPatches: document how to reference previous commits,\n>> 2016-07-28) the format for referring to older commits was specified.\n>>\n>> Make the text generated by the \"Copy commit summary\" command match this\n>> format.\n>\n> Hmph. I didn't know gitk already had its own command to produce a\n> short string. I actually think what it produces\n\nIt was added in d835dbb91fe (gitk: Add a \"Copy commit summary\" command,\n2015-07-18), it doesn't seem to be in your tree yet, so maybe wait\nwith this patch\nuntil you pulled gitk?\n\n>\n>> In 175d38c (\"SubmittingPatches: document how to reference previous commits\",\n>> 2016-07-28) the format for referring to older commits was specified.\n>\n> is easier to read when pasted into a sentence than what the recent\n> update 175d38ca (\"SubmittingPatches: document how to reference\n> previous commits\", 2016-07-28) suggests to do, i.e.\n>\n>> In 175d38c (SubmittingPatches: document how to reference previous commits,\n>> 2016-07-28) the format for referring to older commits was specified.\n>\n> Heiko, Stefan, I think you two were involved in adding that new\n> paragraph. What do you think?\n\nSo the subtle difference is adding '\"' around the commit message subject?\n\nI agree we should fix that.\n"},{"id":"300303","messageId":"6afee090-fbe1-5d05-1f7e-6f0fc4901418@drbeat.li","threadId":"43938","inReplyTo":"CAGZ79kbL13b=iZiFKW8a=G+2zXRSwjYDTzu2TS47Ppohgzm0Gg@mail.gmail.com","subject":"Re: [PATCH 1/2] gitk: align the commit summary format to the documentation","fromName":"Beat Bolli","fromEmail":"dev+git@drbeat.li","sentAt":"2016-08-26T20:27:29Z","receivedAt":"2016-08-26T20:40:53Z","isPatch":true,"sender":{"key":"dev+git@drbeat.li","avatar":"https://avatars.githubusercontent.com/u/21444?v=4"},"body":"On 26.08.16 21:16, Stefan Beller wrote:\n> On Fri, Aug 26, 2016 at 11:24 AM, Junio C Hamano wrote:\n>> Beat Bolli writes:\n>>\n>>> In 175d38c (SubmittingPatches: document how to reference previous commits,\n>>> 2016-07-28) the format for referring to older commits was specified.\n>>>\n>>> Make the text generated by the \"Copy commit summary\" command match this\n>>> format.\n>>\n>> Hmph. I didn't know gitk already had its own command to produce a\n>> short string. I actually think what it produces\n> \n> It was added in d835dbb91fe (gitk: Add a \"Copy commit summary\" command,\n> 2015-07-18), it doesn't seem to be in your tree yet, so maybe wait\n> with this patch\n> until you pulled gitk?\n\nThis commit was part of release 2.6.0.\n\n>>> In 175d38c (\"SubmittingPatches: document how to reference previous commits\",\n>>> 2016-07-28) the format for referring to older commits was specified.\n>>\n>> is easier to read when pasted into a sentence than what the recent\n>> update 175d38ca (\"SubmittingPatches: document how to reference\n>> previous commits\", 2016-07-28) suggests to do, i.e.\n>>\n>>> In 175d38c (SubmittingPatches: document how to reference previous commits,\n>>> 2016-07-28) the format for referring to older commits was specified.\n>>\n>> Heiko, Stefan, I think you two were involved in adding that new\n>> paragraph. What do you think?\n> \n> So the subtle difference is adding '\"' around the commit message subject?\n> \n> I agree we should fix that.\n\nSo would you prepare a amendment to your documentation commit so that\nJunio can disregard my two patches?\n\nThanks,\nBeat\n"},{"id":"300308","messageId":"xmqqtwe7dxuy.fsf@gitster.mtv.corp.google.com","threadId":"43938","inReplyTo":"6afee090-fbe1-5d05-1f7e-6f0fc4901418@drbeat.li","subject":"Re: [PATCH 1/2] gitk: align the commit summary format to the documentation","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2016-08-26T21:27:49Z","receivedAt":"2016-08-26T21:30:30Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Beat Bolli writes:\n\n> On 26.08.16 21:16, Stefan Beller wrote:\n>> I agree we should fix that.\n>\n> So would you prepare a amendment to your documentation commit so that\n> Junio can disregard my two patches?\n\nI think the mention of gitk having a feature to easily give you a\ncommit name in the preferred format added by your 2/2 is worth\nkeeping. I am not Stefan, though ;-)\n"},{"id":"300311","messageId":"CAGZ79kZmCgT5JzHrwjVLw--FtjTSVzrYb-ZX8kNCsvE-b8CREg@mail.gmail.com","threadId":"43938","inReplyTo":"xmqqtwe7dxuy.fsf@gitster.mtv.corp.google.com","subject":"Re: [PATCH 1/2] gitk: align the commit summary format to the documentation","fromName":"Stefan Beller","fromEmail":"sbeller@google.com","sentAt":"2016-08-26T22:29:07Z","receivedAt":"2016-08-26T22:29:12Z","isPatch":true,"sender":{"key":"stefanbeller@gmail.com","avatar":"https://avatars.githubusercontent.com/u/455868?v=4"},"body":"On Fri, Aug 26, 2016 at 2:27 PM, Junio C Hamano wrote:\n> Beat Bolli writes:\n>\n>> On 26.08.16 21:16, Stefan Beller wrote:\n>>> I agree we should fix that.\n>>\n>> So would you prepare a amendment to your documentation commit so that\n>> Junio can disregard my two patches?\n>\n> I think the mention of gitk having a feature to easily give you a\n> commit name in the preferred format added by your 2/2 is worth\n> keeping. I am not Stefan, though ;-)\n\nI just sent a patch to the list to fix the formatting in SubmittingPatches.\nPlease keep 2/2, though ?\n\nThanks,\nStefan\n"},{"id":"300323","messageId":"CA+P7+xopLOwWO22j8i7iWjGM-+vn0ScS9mLVNrB-qt3YCX_=yw@mail.gmail.com","threadId":"43938","inReplyTo":"xmqqk2f3gzcm.fsf@gitster.mtv.corp.google.com","subject":"Re: [PATCH 2/2] SubmittingPatches: hint at gitk's \"Copy commit summary\" command","fromName":"Jacob Keller","fromEmail":"jacob.keller@gmail.com","sentAt":"2016-08-27T03:58:34Z","receivedAt":"2016-08-27T03:59:01Z","isPatch":true,"sender":{"key":"jacob.keller@gmail.com","avatar":"https://avatars.githubusercontent.com/u/874719?v=4"},"body":"On Fri, Aug 26, 2016 at 11:27 AM, Junio C Hamano wrote:\n> Beat Bolli writes:\n>\n>> @@ -124,7 +124,8 @@ archive, summarize the relevant points of the discussion.\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>> +noticed [...]\". The \"Copy commit summary\" command of gitk generates this\n>> +format.\n>\n> (continuing from my 1/2 review) And if people agree that the format\n> gitk already uses is better, this text should probably read more\n> like:\n>\n> If you want to reference a previous commit in the history of a\n> stable 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\nTangent, but I was wondering if this would make a good built-in\nformat, but then I looked and realized that the built-in formats\ndidn't make much sense to me... I'm not sure where the actual format\ngets displayed so I am wondering if we had any thoughts about adding\nsome --pretty=summary that we could add? I know it can be implemented\nvia a user defined format but thought it might be worth building it in\nsince it's a pretty common use case?\n\nThanks,\nJake\n"},{"id":"300324","messageId":"a9731f60-5c30-0bc6-f73a-f7ffb7bd4231@kdbg.org","threadId":"43938","inReplyTo":"xmqqoa4fgzhv.fsf@gitster.mtv.corp.google.com","subject":"Re: [PATCH 1/2] gitk: align the commit summary format to the documentation","fromName":"Johannes Sixt","fromEmail":"j6t@kdbg.org","sentAt":"2016-08-27T07:21:33Z","receivedAt":"2016-08-27T07:22:20Z","isPatch":true,"sender":{"key":"j6t@kdbg.org","avatar":"https://avatars.githubusercontent.com/u/14810926?v=4"},"body":"Am 26.08.2016 um 20:24 schrieb Junio C Hamano:\n> Beat Bolli writes:\n>> In 175d38c (\"SubmittingPatches: document how to reference previous commits\",\n>> 2016-07-28) the format for referring to older commits was specified.\n>\n> is easier to read when pasted into a sentence than what the recent\n> update 175d38ca (\"SubmittingPatches: document how to reference\n> previous commits\", 2016-07-28) suggests to do, i.e.\n\nWhile it may be easier to read due to the extra mark-up, the resulting \ntext where such a quotation appears does not flow well, IMO. A commit \nmessage text that references another commit reads more fluently without \nthe quotes around the summary line because the quoted text is not so \nmuch a quotation that must be marked, but a parenthetical statement.\n\nI absolutely welcome the proposed change to gitk, because I always edit \nout the double-quotes.\n\n-- Hannes\n\n"},{"id":"300478","messageId":"xmqqpoorbftc.fsf@gitster.mtv.corp.google.com","threadId":"43938","inReplyTo":"a9731f60-5c30-0bc6-f73a-f7ffb7bd4231@kdbg.org","subject":"Re: [PATCH 1/2] gitk: align the commit summary format to the documentation","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2016-08-29T18:17:19Z","receivedAt":"2016-08-29T18:17:28Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Johannes Sixt writes:\n\n> Am 26.08.2016 um 20:24 schrieb Junio C Hamano:\n>> Beat Bolli writes:\n>>> In 175d38c (\"SubmittingPatches: document how to reference previous commits\",\n>>> 2016-07-28) the format for referring to older commits was specified.\n>>\n>> is easier to read when pasted into a sentence than what the recent\n>> update 175d38ca (\"SubmittingPatches: document how to reference\n>> previous commits\", 2016-07-28) suggests to do, i.e.\n>\n> While it may be easier to read due to the extra mark-up, the resulting\n> text where such a quotation appears does not flow well, IMO. A commit\n> message text that references another commit reads more fluently\n> without the quotes around the summary line because the quoted text is\n> not so much a quotation that must be marked, but a parenthetical\n> statement.\n>\n> I absolutely welcome the proposed change to gitk, because I always\n> edit out the double-quotes.\n\nI think that is highly subjective, and as you very well may know,\nI've been referring to commits without double-quote pair, and have\nan obvious bias for something I am used to ;-)\n\nI do not see the \"\" as introducing a quotation. I just view it as\nvery similar to the \"\" in the following sentence:\n\n The commit whose title is \"foo bar\" did not consider there is\n also need to consider baz.\n\nThe whole thing is inside () pair, so I agree that with or without\n\"\" pair, it is possible to see where the title ends. So I do not\nhave a strong opinion either way.\n\n"},{"id":"300481","messageId":"20160829183015.2uqnfezekjfa3ott@sigill.intra.peff.net","threadId":"43938","inReplyTo":"xmqqpoorbftc.fsf@gitster.mtv.corp.google.com","subject":"Re: [PATCH 1/2] gitk: align the commit summary format to the documentation","fromName":"Jeff King","fromEmail":"peff@peff.net","sentAt":"2016-08-29T18:30:15Z","receivedAt":"2016-08-29T18:30:25Z","isPatch":true,"sender":{"key":"peff@peff.net","avatar":"https://avatars.githubusercontent.com/u/45925?v=4"},"body":"On Mon, Aug 29, 2016 at 11:17:19AM -0700, Junio C Hamano wrote:\n\n> > While it may be easier to read due to the extra mark-up, the resulting\n> > text where such a quotation appears does not flow well, IMO. A commit\n> > message text that references another commit reads more fluently\n> > without the quotes around the summary line because the quoted text is\n> > not so much a quotation that must be marked, but a parenthetical\n> > statement.\n> >\n> > I absolutely welcome the proposed change to gitk, because I always\n> > edit out the double-quotes.\n> \n> I think that is highly subjective, and as you very well may know,\n> I've been referring to commits without double-quote pair, and have\n> an obvious bias for something I am used to ;-)\n> \n> I do not see the \"\" as introducing a quotation. I just view it as\n> very similar to the \"\" in the following sentence:\n> \n> The commit whose title is \"foo bar\" did not consider there is\n> also need to consider baz.\n> \n> The whole thing is inside () pair, so I agree that with or without\n> \"\" pair, it is possible to see where the title ends. So I do not\n> have a strong opinion either way.\n\nI have an alias which produces similar output, without the double-quotes\n(probably because I stole it from you originally).\n\nI have noticed over the years that the output is occasionally ugly when\nthe commit names have parentheses themselves. E.g.:\n\n $ git config alias.ll\n !git --no-pager log -1 --pretty='tformat:%h (%s, %ad)' --date=short\n\n $ git ll 7e97e10\n 7e97e10 (die(_(\"BUG\")): avoid translating bug messages, 2016-07-26)\n\n $ git ll fa90ab4\n fa90ab4 (t3404: fix a grammo (commands are ran -> commands are run), 2016-06-29)\n\nAdding quotes can help with that. OTOH, I think it just introduces the\nsame problem with a different character. E.g.:\n\n $ git ll be00b57\n be00b57 (provide an initializer for \"struct object_info\", 2016-08-11)\n\n $ git llq be00b57\n be00b57 (\"provide an initializer for \"struct object_info\"\", 2016-08-11)\n\nPerhaps one could write a script to find a custom pretty non-conflicting\ndelimiter for each case, but I don't know if it's worth the effort. :)\n\n-Peff\n"}]}