{"thread":{"id":"39184","subject":"[PATCH] Documentation: Fix inconsistent quotes","startedAt":"2015-04-29T18:08:52Z","lastAt":"2015-05-14T09:14:17Z","messageCount":7,"participants":["Stefan Tatschner","Jeff King","Jonathan Nieder","Junio C Hamano"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"260191","messageId":"1430330932-10578-1-git-send-email-stefan@sevenbyte.org","threadId":"39184","inReplyTo":null,"subject":"[PATCH] Documentation: Fix inconsistent quotes","fromName":"Stefan Tatschner","fromEmail":"stefan@sevenbyte.org","sentAt":"2015-04-29T18:08:52Z","receivedAt":"2015-04-29T18:08:52Z","isPatch":true,"sender":{"key":"stefan@sevenbyte.org","avatar":null},"body":"While reading 'man git' I realized that the highlighting of the\nenvironment variables is not consistent. This patch adds missing single\nquotes and substitutes backticks with the proper quotes as well.\n\nSigned-off-by: Stefan Tatschner <stefan@sevenbyte.org>\n---\n Documentation/git.txt | 10 +++++-----\n 1 file changed, 5 insertions(+), 5 deletions(-)\n\ndiff --git a/Documentation/git.txt b/Documentation/git.txt\nindex 959c9d4..bb345a4 100644\n--- a/Documentation/git.txt\n+++ b/Documentation/git.txt\n@@ -1000,7 +1000,7 @@ Unsetting the variable, or setting it to empty, \"0\" or\n \tcloning of shallow repositories.\n \tSee 'GIT_TRACE' for available trace output options.\n \n-GIT_LITERAL_PATHSPECS::\n+'GIT_LITERAL_PATHSPECS'::\n \tSetting this variable to `1` will cause Git to treat all\n \tpathspecs literally, rather than as glob patterns. For example,\n \trunning `GIT_LITERAL_PATHSPECS=1 git log -- '*.c'` will search\n@@ -1009,15 +1009,15 @@ GIT_LITERAL_PATHSPECS::\n \tliteral paths to Git (e.g., paths previously given to you by\n \t`git ls-tree`, `--raw` diff output, etc).\n \n-GIT_GLOB_PATHSPECS::\n+'GIT_GLOB_PATHSPECS'::\n \tSetting this variable to `1` will cause Git to treat all\n \tpathspecs as glob patterns (aka \"glob\" magic).\n \n-GIT_NOGLOB_PATHSPECS::\n+'GIT_NOGLOB_PATHSPECS'::\n \tSetting this variable to `1` will cause Git to treat all\n \tpathspecs as literal (aka \"literal\" magic).\n \n-GIT_ICASE_PATHSPECS::\n+'GIT_ICASE_PATHSPECS'::\n \tSetting this variable to `1` will cause Git to treat all\n \tpathspecs as case-insensitive.\n \n@@ -1031,7 +1031,7 @@ GIT_ICASE_PATHSPECS::\n \tvariable when it is invoked as the top level command by the\n \tend user, to be recorded in the body of the reflog.\n \n-`GIT_REF_PARANOIA`::\n+'GIT_REF_PARANOIA'::\n \tIf set to `1`, include broken or badly named refs when iterating\n \tover lists of refs. In a normal, non-corrupted repository, this\n \tdoes nothing. However, enabling it may help git to detect and\n-- \n2.3.7\n"},{"id":"260192","messageId":"20150429185141.GA32207@peff.net","threadId":"39184","inReplyTo":"1430330932-10578-1-git-send-email-stefan@sevenbyte.org","subject":"Re: [PATCH] Documentation: Fix inconsistent quotes","fromName":"Jeff King","fromEmail":"peff@peff.net","sentAt":"2015-04-29T18:51:41Z","receivedAt":"2015-04-29T18:51:41Z","isPatch":true,"sender":{"key":"peff@peff.net","avatar":"https://avatars.githubusercontent.com/u/45925?v=4"},"body":"On Wed, Apr 29, 2015 at 08:08:52PM +0200, Stefan Tatschner wrote:\n\n> While reading 'man git' I realized that the highlighting of the\n> environment variables is not consistent. This patch adds missing single\n> quotes and substitutes backticks with the proper quotes as well.\n\nI think this is OK in that it makes things consistent, and chooses the\nstyle that is already in the majority.\n\nBut IMHO, using backticks looks much better. In the roff-formatted\nmanpages single quotes underline, but backticks use bold. The former is\nhard to read when the content has underscores. For the HTML, the single\nquotes produce italics, versus a typewriter font for backticks. Which\nis...OK, I guess, but I think I like the backtick behavior better.\n\nI think we're wildly inconsistent about this throughout the\ndocumentation, though.\n\n-Peff\n"},{"id":"260193","messageId":"20150429190946.GQ5467@google.com","threadId":"39184","inReplyTo":"20150429185141.GA32207@peff.net","subject":"Re: [PATCH] Documentation: Fix inconsistent quotes","fromName":"Jonathan Nieder","fromEmail":"jrnieder@gmail.com","sentAt":"2015-04-29T19:09:46Z","receivedAt":"2015-04-29T19:09:46Z","isPatch":true,"sender":{"key":"jrnieder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/281595?v=4"},"body":"Hi,\n\nJeff King wrote:\n\n> But IMHO, using backticks looks much better. In the roff-formatted\n> manpages single quotes underline, but backticks use bold.\n\nAre you sure?  My copy of git.1.gz has backticks converted into no\nformatting at all:\n\n\tOther options are available to control how the manual page is displayed\\&. See\n\t\\fBgit-help\\fR(1)\n\tfor more information, because\n\tgit \\-\\-help \\&.\\&.\\&.\n\tis converted internally into\n\tgit help \\&.\\&.\\&.\\&.\n\nThanks,\nJonathan\n"},{"id":"260198","messageId":"20150429200453.GA750@peff.net","threadId":"39184","inReplyTo":"20150429190946.GQ5467@google.com","subject":"Re: [PATCH] Documentation: Fix inconsistent quotes","fromName":"Jeff King","fromEmail":"peff@peff.net","sentAt":"2015-04-29T20:04:54Z","receivedAt":"2015-04-29T20:04:54Z","isPatch":true,"sender":{"key":"peff@peff.net","avatar":"https://avatars.githubusercontent.com/u/45925?v=4"},"body":"On Wed, Apr 29, 2015 at 12:09:46PM -0700, Jonathan Nieder wrote:\n\n> Hi,\n> \n> Jeff King wrote:\n> \n> > But IMHO, using backticks looks much better. In the roff-formatted\n> > manpages single quotes underline, but backticks use bold.\n> \n> Are you sure?  My copy of git.1.gz has backticks converted into no\n> formatting at all:\n> \n> \tOther options are available to control how the manual page is displayed\\&. See\n> \t\\fBgit-help\\fR(1)\n> \tfor more information, because\n> \tgit \\-\\-help \\&.\\&.\\&.\n> \tis converted internally into\n> \tgit help \\&.\\&.\\&.\\&.\n\nIt's actually optional. See 5121a6d (Documentation: option to render\nliteral text as bold for manpages, 2009-03-27). I don't see a good\nreason that wasn't made the default early, except conservatism. I've had\nit enabled for years (though I admit I don't read the manpages that much\nthese days :) ).\n\n-Peff\n"},{"id":"260199","messageId":"xmqqpp6m4rr2.fsf@gitster.dls.corp.google.com","threadId":"39184","inReplyTo":"20150429200453.GA750@peff.net","subject":"Re: [PATCH] Documentation: Fix inconsistent quotes","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2015-04-29T20:13:53Z","receivedAt":"2015-04-29T20:13:53Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Jeff King <peff@peff.net> writes:\n\n> On Wed, Apr 29, 2015 at 12:09:46PM -0700, Jonathan Nieder wrote:\n>\n>> Hi,\n>> \n>> Jeff King wrote:\n>> \n>> > But IMHO, using backticks looks much better. In the roff-formatted\n>> > manpages single quotes underline, but backticks use bold.\n>> \n>> Are you sure?  My copy of git.1.gz has backticks converted into no\n>> formatting at all:\n>> \n>> \tOther options are available to control how the manual page is displayed\\&. See\n>> \t\\fBgit-help\\fR(1)\n>> \tfor more information, because\n>> \tgit \\-\\-help \\&.\\&.\\&.\n>> \tis converted internally into\n>> \tgit help \\&.\\&.\\&.\\&.\n>\n> It's actually optional. See 5121a6d (Documentation: option to render\n> literal text as bold for manpages, 2009-03-27). I don't see a good\n> reason that wasn't made the default early, except conservatism. I've had\n> it enabled for years (though I admit I don't read the manpages that much\n> these days :) ).\n\nInteresting.  What I happen to use when populating the git-manpages\nrepository would have wider impact to the users, as I hear that some\n(or many) distros just package whatever I have there.  I do not mind\nenabling it on my end if that gives us more readable rendition.\n"},{"id":"260200","messageId":"20150429203247.GA1685@peff.net","threadId":"39184","inReplyTo":"xmqqpp6m4rr2.fsf@gitster.dls.corp.google.com","subject":"Re: [PATCH] Documentation: Fix inconsistent quotes","fromName":"Jeff King","fromEmail":"peff@peff.net","sentAt":"2015-04-29T20:32:47Z","receivedAt":"2015-04-29T20:32:47Z","isPatch":true,"sender":{"key":"peff@peff.net","avatar":"https://avatars.githubusercontent.com/u/45925?v=4"},"body":"On Wed, Apr 29, 2015 at 01:13:53PM -0700, Junio C Hamano wrote:\n\n> > It's actually optional. See 5121a6d (Documentation: option to render\n> > literal text as bold for manpages, 2009-03-27). I don't see a good\n> > reason that wasn't made the default early, except conservatism. I've had\n> > it enabled for years (though I admit I don't read the manpages that much\n> > these days :) ).\n> \n> Interesting.  What I happen to use when populating the git-manpages\n> repository would have wider impact to the users, as I hear that some\n> (or many) distros just package whatever I have there.  I do not mind\n> enabling it on my end if that gives us more readable rendition.\n\nI think it's probably fine and a positive change, but one never knows. I\nguess distros don't package what you ship until you actually tag a\nrelease, so it would be OK to start doing so during a cycle to shake out\nany problems (and in fact preferable, as anybody who follows \"master\"\nusing \"make install-man-quick\" would get it early and be able to make a\nreport).\n\nIf we are doing that, it would make sense to flip MAN_BOLD_LITERAL on by\ndefault during that same cycle, so we could get reports from people who\nbuild the manpages from source.\n\n-Peff\n"},{"id":"261224","messageId":"1431594857.15159.4.camel@sevenbyte.org","threadId":"39184","inReplyTo":"1430330932-10578-1-git-send-email-stefan@sevenbyte.org","subject":"Re: [PATCH] Documentation: Fix inconsistent quotes","fromName":"Stefan Tatschner","fromEmail":"stefan@sevenbyte.org","sentAt":"2015-05-14T09:14:17Z","receivedAt":"2015-05-14T09:14:17Z","isPatch":true,"sender":{"key":"stefan@sevenbyte.org","avatar":null},"body":"On Wed, 2015-04-29 at 20:08 +0200, Stefan Tatschner wrote:\n> While reading 'man git' I realized that the highlighting of the\n> environment variables is not consistent. This patch adds missing \n> single\n> quotes and substitutes backticks with the proper quotes as well.\n\nSince currently there are some patches around which aim to improve the\ndocumentation, may I ask about the status of this patch? Should I\nimprove/modify something, or is it actually not needed?\n\nThanks,\nStefan\n"}]}