{"thread":{"id":"45250","subject":"[PATCH 2/2] docs/diffcore: unquote \"Complete Rewrites\" in headers","startedAt":"2017-02-28T08:59:18Z","lastAt":"2017-02-28T17:43:18Z","messageCount":4,"participants":["Patrick Steinhardt","Jeff King","Junio C Hamano"],"isPatch":true,"patchVersion":1,"patchTotal":2},"messages":[{"id":"312824","messageId":"576fa5be072ebd503aa553ef24290c77ed34eeb1.1488272203.git.patrick.steinhardt@elego.de","threadId":"45250","inReplyTo":"2882e77a58e4219d60a39827c3ea8d4537d5178a.1488272203.git.patrick.steinhardt@elego.de","subject":"[PATCH 2/2] docs/diffcore: unquote \"Complete Rewrites\" in headers","fromName":"Patrick Steinhardt","fromEmail":"patrick.steinhardt@elego.de","sentAt":"2017-02-28T08:59:05Z","receivedAt":"2017-02-28T08:59:18Z","isPatch":true,"sender":{"key":"ps@pks.im","avatar":"https://avatars.githubusercontent.com/u/4056630?v=4"},"body":"The gitdiffcore documentation quotes the term \"Complete Rewrites\" in\nheaders for no real gain. This would make sense if the term could be\neasily confused if not properly grouped together. But actually, the term\nis quite obvious and thus does not really need any quoting, especially\nregarding that it is not used anywhere else.\n\nBut more importanly, this brings up a bug when rendering man pages: when\ntrying to render quotes inside of a section header, we end up with\nquotes which have been misaligned to the end of line. E.g.\n\n diffcore-break: For Splitting Up Complete Rewrites\n --------------------------------------------------\n\nrenders as\n\n DIFFCORE-BREAK: FOR SPLITTING UP COMPLETE REWRITES\"\"\n\n, which is obviously wrong. While this is fixable for the man pages by\nusing double-quotes (e.g. \"\"COMPLETE REWRITES\"\"), this again breaks it\nfor our generated HTML pages.\n\nSo fix the issue by simply dropping quotes inside of section headers,\nwhich is currently only done for the term \"Complete Rewrites\".\n\nSigned-off-by: Patrick Steinhardt \n---\n\nThe obvious other route here would be to fix how the stylesheets\nhandle quoting inside of these headers. But after taking a short\nlook, I didn't really get how our stylesheets actually stitch\ntogether and as such bailed from doing so.\n\n Documentation/gitdiffcore.txt | 8 ++++----\n 1 file changed, 4 insertions(+), 4 deletions(-)\n\ndiff --git a/Documentation/gitdiffcore.txt b/Documentation/gitdiffcore.txt\nindex cf009a187..c0a60f315 100644\n--- a/Documentation/gitdiffcore.txt\n+++ b/Documentation/gitdiffcore.txt\n@@ -84,8 +84,8 @@ format sections of the manual for 'git diff-{asterisk}' commands) or\n diff-patch format.\n \n \n-diffcore-break: For Splitting Up \"Complete Rewrites\"\n-----------------------------------------------------\n+diffcore-break: For Splitting Up Complete Rewrites\n+--------------------------------------------------\n \n The second transformation in the chain is diffcore-break, and is\n controlled by the -B option to the 'git diff-{asterisk}' commands. This is\n@@ -177,8 +177,8 @@ the expense of making it slower. Without `--find-copies-harder`,\n copied happened to have been modified in the same changeset.\n \n \n-diffcore-merge-broken: For Putting \"Complete Rewrites\" Back Together\n---------------------------------------------------------------------\n+diffcore-merge-broken: For Putting Complete Rewrites Back Together\n+------------------------------------------------------------------\n \n This transformation is used to merge filepairs broken by\n diffcore-break, and not transformed into rename/copy by\n-- \n2.12.0\n\n"},{"id":"312825","messageId":"2882e77a58e4219d60a39827c3ea8d4537d5178a.1488272203.git.patrick.steinhardt@elego.de","threadId":"45250","inReplyTo":null,"subject":"[PATCH 1/2] docs/diffcore: fix grammar in diffcore-rename header","fromName":"Patrick Steinhardt","fromEmail":"patrick.steinhardt@elego.de","sentAt":"2017-02-28T08:59:04Z","receivedAt":"2017-02-28T08:59:19Z","isPatch":true,"sender":{"key":"ps@pks.im","avatar":"https://avatars.githubusercontent.com/u/4056630?v=4"},"body":"Signed-off-by: Patrick Steinhardt \n---\n Documentation/gitdiffcore.txt | 2 +-\n 1 file changed, 1 insertion(+), 1 deletion(-)\n\ndiff --git a/Documentation/gitdiffcore.txt b/Documentation/gitdiffcore.txt\nindex 46bc6d077..cf009a187 100644\n--- a/Documentation/gitdiffcore.txt\n+++ b/Documentation/gitdiffcore.txt\n@@ -119,7 +119,7 @@ the original is used), and can be customized by giving a number\n after \"-B\" option (e.g. \"-B75\" to tell it to use 75%).\n \n \n-diffcore-rename: For Detection Renames and Copies\n+diffcore-rename: For Detecting Renames and Copies\n -------------------------------------------------\n \n This transformation is used to detect renames and copies, and is\n-- \n2.12.0\n\n"},{"id":"312835","messageId":"20170228123753.6k646m7jnyc5uoav@sigill.intra.peff.net","threadId":"45250","inReplyTo":"576fa5be072ebd503aa553ef24290c77ed34eeb1.1488272203.git.patrick.steinhardt@elego.de","subject":"Re: [PATCH 2/2] docs/diffcore: unquote \"Complete Rewrites\" in headers","fromName":"Jeff King","fromEmail":"peff@peff.net","sentAt":"2017-02-28T12:37:54Z","receivedAt":"2017-02-28T12:38:01Z","isPatch":true,"sender":{"key":"peff@peff.net","avatar":"https://avatars.githubusercontent.com/u/45925?v=4"},"body":"On Tue, Feb 28, 2017 at 09:59:05AM +0100, Patrick Steinhardt wrote:\n\n> The gitdiffcore documentation quotes the term \"Complete Rewrites\" in\n> headers for no real gain. This would make sense if the term could be\n> easily confused if not properly grouped together. But actually, the term\n> is quite obvious and thus does not really need any quoting, especially\n> regarding that it is not used anywhere else.\n> \n> But more importanly, this brings up a bug when rendering man pages: when\n> trying to render quotes inside of a section header, we end up with\n> quotes which have been misaligned to the end of line. E.g.\n> \n> diffcore-break: For Splitting Up Complete Rewrites\n> --------------------------------------------------\n> \n> renders as\n> \n> DIFFCORE-BREAK: FOR SPLITTING UP COMPLETE REWRITES\"\"\n> \n> , which is obviously wrong. While this is fixable for the man pages by\n> using double-quotes (e.g. \"\"COMPLETE REWRITES\"\"), this again breaks it\n> for our generated HTML pages.\n> \n> So fix the issue by simply dropping quotes inside of section headers,\n> which is currently only done for the term \"Complete Rewrites\".\n\nThanks for a nice explanation of the issue. I was curious whether\nasciidoctor gets this right. It does, though I suppose that's because we\nonly look at the HTML output. It sounds like the issue is in the\ndocbook->roff path.\n\nAt any rate, I agree with your analysis. It's not worth futzing with the\nformatting when it reads just as well without the quotes.\n\n-Peff\n"},{"id":"312858","messageId":"xmqqr32ikyqr.fsf@gitster.mtv.corp.google.com","threadId":"45250","inReplyTo":"2882e77a58e4219d60a39827c3ea8d4537d5178a.1488272203.git.patrick.steinhardt@elego.de","subject":"Re: [PATCH 1/2] docs/diffcore: fix grammar in diffcore-rename header","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2017-02-28T17:32:12Z","receivedAt":"2017-02-28T17:43:18Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Patrick Steinhardt writes:\n\n> Signed-off-by: Patrick Steinhardt \n> ---\n> Documentation/gitdiffcore.txt | 2 +-\n> 1 file changed, 1 insertion(+), 1 deletion(-)\n>\n> diff --git a/Documentation/gitdiffcore.txt b/Documentation/gitdiffcore.txt\n> index 46bc6d077..cf009a187 100644\n> --- a/Documentation/gitdiffcore.txt\n> +++ b/Documentation/gitdiffcore.txt\n> @@ -119,7 +119,7 @@ the original is used), and can be customized by giving a number\n> after \"-B\" option (e.g. \"-B75\" to tell it to use 75%).\n> \n> \n> -diffcore-rename: For Detection Renames and Copies\n> +diffcore-rename: For Detecting Renames and Copies\n> -------------------------------------------------\n> \n> This transformation is used to detect renames and copies, and is\n\nThanks for carefully reading. Both looks reasonable.\n"}]}