{"thread":{"id":"46813","subject":"[PATCH] doc: put literal block delimiter around table","startedAt":"2017-09-23T05:55:33Z","lastAt":"2017-09-23T05:55:33Z","messageCount":1,"participants":["Jeff King"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"328717","messageId":"20170923055526.audcysedpxdst6tm@sigill.intra.peff.net","threadId":"46813","inReplyTo":null,"subject":"[PATCH] doc: put literal block delimiter around table","fromName":"Jeff King","fromEmail":"peff@peff.net","sentAt":"2017-09-23T05:55:26Z","receivedAt":"2017-09-23T05:55:33Z","isPatch":true,"sender":{"key":"peff@peff.net","avatar":"https://avatars.githubusercontent.com/u/45925?v=4"},"body":"The git-read-tree manpage has a table that is meant to\nbe shown with its spacing exactly as it is in the source. We\nmark it as a \"literal paragraph\" by indenting each line by\nat least one space. This renders OK with asciidoc for both\nthe HTML and manpage versions.\n\nBut there are two problems when we render it with\nasciidoctor.\n\nThe first is that some lines mix tabs and spaces.  Even if\nasciidoctor is correctly configured for 8-space tabs, it\nseems to handle this case differently, soaking up some of\nthe initial literal-paragraph spaces and mis-aligning the\ntable text.\n\nThe second problem is that the table uses blank lines to\ngroup rows. But as blank lines separate paragraphs in\nasciidoc, this actually means that each chunk of the table\nis rendered in its own pre-formatted <div> block. This\nhappens even with vanilla asciidoc, but there's no visible\nresult because the literal paragraphs aren't styled in any\nspecial way. But with asciidoctor (or at least the styles\nused on git-scm.com), literal paragraphs are styled with a\ndifferent background.  This breaks the table into a visually\ndistracting sequence of chunks.\n\nWe can fix both by adding a literal-paragraph block\ndelimiter. That turns the whole table into a single block\n(for both implementations) and causes asciidoctor to render\nthe indentation as it is in the source.\n\nReported-at: https://github.com/git/git-scm.com/issues/1023\nSigned-off-by: Jeff King <peff@peff.net>\n---\n Documentation/git-read-tree.txt | 2 ++\n 1 file changed, 2 insertions(+)\n\ndiff --git a/Documentation/git-read-tree.txt b/Documentation/git-read-tree.txt\nindex 02576d8c0a..72bd809fb8 100644\n--- a/Documentation/git-read-tree.txt\n+++ b/Documentation/git-read-tree.txt\n@@ -179,6 +179,7 @@ Here are the \"carry forward\" rules, where \"I\" denotes the index,\n \"clean\" means that index and work tree coincide, and \"exists\"/\"nothing\"\n refer to the presence of a path in the specified commit:\n \n+....\n \tI                   H        M        Result\n        -------------------------------------------------------\n      0  nothing             nothing  nothing  (does not happen)\n@@ -217,6 +218,7 @@ refer to the presence of a path in the specified commit:\n      19 no    no    yes     exists   exists   keep index\n      20 yes   yes   no      exists   exists   use M\n      21 no    yes   no      exists   exists   fail\n+....\n \n In all \"keep index\" cases, the index entry stays as in the\n original index file.  If the entry is not up to date,\n-- \n2.14.1.1053.gacbfefb3f2\n"}]}