{"thread":{"id":"34048","subject":"[PATCH] fetch doc: escape asterisk in --tags paragraph","startedAt":"2013-06-07T11:31:34Z","lastAt":"2013-06-07T15:13:13Z","messageCount":4,"participants":["Ramkumar Ramachandra","Junio C Hamano"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"219621","messageId":"1370604694-2438-1-git-send-email-artagnon@gmail.com","threadId":"34048","inReplyTo":null,"subject":"[PATCH] fetch doc: escape asterisk in --tags paragraph","fromName":"Ramkumar Ramachandra","fromEmail":"artagnon@gmail.com","sentAt":"2013-06-07T11:31:34Z","receivedAt":"2013-06-07T11:31:34Z","isPatch":true,"sender":{"key":"r@artagnon.com","avatar":"https://avatars.githubusercontent.com/u/37226?v=4"},"body":"Currently, the paragraph corresponding to the --tags option in\ngit-fetch(1) looks like:\n\n -t, --tags\n This is a short-hand for giving \"refs/tags/:refs/tags/\" refspec\n ^^^^^^^^^^^\n\t\t\t\t\t\t this is in bold\n\nThis happens because the corresponding text in fetch-options.txt is\n\"refs/tags/*:refs/tags/*\"; asciidoc renders the text between the two\nasterisks in bold. Escape the first asterisk, correcting the text.\n\nSigned-off-by: Ramkumar Ramachandra \n---\n Candidate for maint?\n\n Documentation/fetch-options.txt | 2 +-\n 1 file changed, 1 insertion(+), 1 deletion(-)\n\ndiff --git a/Documentation/fetch-options.txt b/Documentation/fetch-options.txt\nindex 9cb6496..5f68149 100644\n--- a/Documentation/fetch-options.txt\n+++ b/Documentation/fetch-options.txt\n@@ -61,7 +61,7 @@ endif::git-pull[]\n ifndef::git-pull[]\n -t::\n --tags::\n-\tThis is a short-hand for giving \"refs/tags/*:refs/tags/*\"\n+\tThis is a short-hand for giving \"refs/tags/\\*:refs/tags/*\"\n \trefspec from the command line, to ask all tags to be fetched\n \tand stored locally. Because this acts as an explicit\n \trefspec, the default refspecs (configured with the\n-- \n1.8.3.20.g7940bce.dirty\n"},{"id":"219634","messageId":"7vppvyugeg.fsf@alter.siamese.dyndns.org","threadId":"34048","inReplyTo":"1370604694-2438-1-git-send-email-artagnon@gmail.com","subject":"Re: [PATCH] fetch doc: escape asterisk in --tags paragraph","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2013-06-07T14:47:19Z","receivedAt":"2013-06-07T14:47:19Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Ramkumar Ramachandra writes:\n\n> Currently, the paragraph corresponding to the --tags option in\n> git-fetch(1) looks like:\n>\n> -t, --tags\n> This is a short-hand for giving \"refs/tags/:refs/tags/\" refspec\n> ^^^^^^^^^^^\n> \t\t\t\t\t\t this is in bold\n>\n> This happens because the corresponding text in fetch-options.txt is\n> \"refs/tags/*:refs/tags/*\"; asciidoc renders the text between the two\n> asterisks in bold. Escape the first asterisk, correcting the text.\n>\n> Signed-off-by: Ramkumar Ramachandra \n> ---\n> Candidate for maint?\n\nThe issue certainly is real and needs a fix for maint. Your\nsolution I am not sure about.\n\n $ git grep '\\\\\\*' -- Documentation/\\*.txt\n\nshows only two meaningful hits (git-rm.txt and git-svn.txt);\neverybody else uses\n\n$ git grep '{asterisk}' -- Documentation/\\*.txt\n\nand the one you spotted in fetch-options.txt is very similar to the\none appears in git-pull.txt, I think.\n\n\n> Documentation/fetch-options.txt | 2 +-\n> 1 file changed, 1 insertion(+), 1 deletion(-)\n>\n> diff --git a/Documentation/fetch-options.txt b/Documentation/fetch-options.txt\n> index 9cb6496..5f68149 100644\n> --- a/Documentation/fetch-options.txt\n> +++ b/Documentation/fetch-options.txt\n> @@ -61,7 +61,7 @@ endif::git-pull[]\n> ifndef::git-pull[]\n> -t::\n> --tags::\n> -\tThis is a short-hand for giving \"refs/tags/*:refs/tags/*\"\n> +\tThis is a short-hand for giving \"refs/tags/\\*:refs/tags/*\"\n> \trefspec from the command line, to ask all tags to be fetched\n> \tand stored locally. Because this acts as an explicit\n> \trefspec, the default refspecs (configured with the\n"},{"id":"219635","messageId":"7vk3m6ufcw.fsf@alter.siamese.dyndns.org","threadId":"34048","inReplyTo":"7vppvyugeg.fsf@alter.siamese.dyndns.org","subject":"Re: [PATCH] fetch doc: escape asterisk in --tags paragraph","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2013-06-07T15:09:51Z","receivedAt":"2013-06-07T15:09:51Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Junio C Hamano writes:\n\n> Ramkumar Ramachandra writes:\n>\n>> Currently, the paragraph corresponding to the --tags option in\n>> git-fetch(1) looks like:\n>>\n>> -t, --tags\n>> This is a short-hand for giving \"refs/tags/:refs/tags/\" refspec\n>> ^^^^^^^^^^^\n>> \t\t\t\t\t\t this is in bold\n>>\n>> This happens because the corresponding text in fetch-options.txt is\n>> \"refs/tags/*:refs/tags/*\"; asciidoc renders the text between the two\n>> asterisks in bold. Escape the first asterisk, correcting the text.\n>>\n>> Signed-off-by: Ramkumar Ramachandra \n>> ---\n>> Candidate for maint?\n>\n> The issue certainly is real and needs a fix for maint. Your\n> solution I am not sure about.\n>\n> $ git grep '\\\\\\*' -- Documentation/\\*.txt\n>\n> shows only two meaningful hits (git-rm.txt and git-svn.txt);\n> everybody else uses\n>\n> $ git grep '{asterisk}' -- Documentation/\\*.txt\n>\n> and the one you spotted in fetch-options.txt is very similar to the\n> one appears in git-pull.txt, I think.\n\nHow about this?\n\n-- >8 --\nSubject: fetch-options.txt: prevent wildcard refspec from getting misformatted \n\nWhen explaining the \"--tags\" option as an equivalent to giving an\nexplicit \"refs/tags/*:refs/tags/*\" refspec, the two asterisks were\nmisinterpreted by AsciiDoc as a request to typeset the string\nsegment between them in bold.\n\nWe could fix it in two ways. We can replace them with {asterisk}s\nwhile keeping the string as body text, or we can mark it as a\nliteral string by using the backquotes around it.\n\nLet's do the latter, as it is teaching the user an \"exactly as\ntyped\" alternative.\n\nNoticed-by: Ramkumar Ramachandra \nSigned-off-by: Junio C Hamano \n---\n Documentation/fetch-options.txt | 2 +-\n 1 file changed, 1 insertion(+), 1 deletion(-)\n\ndiff --git a/Documentation/fetch-options.txt b/Documentation/fetch-options.txt\nindex 6e98bdf..c87bf39 100644\n--- a/Documentation/fetch-options.txt\n+++ b/Documentation/fetch-options.txt\n@@ -57,7 +57,7 @@ endif::git-pull[]\n ifndef::git-pull[]\n -t::\n --tags::\n-\tThis is a short-hand for giving \"refs/tags/*:refs/tags/*\"\n+\tThis is a short-hand for giving `refs/tags/*:refs/tags/*`\n \trefspec from the command line, to ask all tags to be fetched\n \tand stored locally. Because this acts as an explicit\n \trefspec, the default refspecs (configured with the\n"},{"id":"219636","messageId":"CALkWK0=Oi_PzLni=Hxw6fh=8s1SjKJCmQf0xDSmCPSg_OBrYHQ@mail.gmail.com","threadId":"34048","inReplyTo":"7vk3m6ufcw.fsf@alter.siamese.dyndns.org","subject":"Re: [PATCH] fetch doc: escape asterisk in --tags paragraph","fromName":"Ramkumar Ramachandra","fromEmail":"artagnon@gmail.com","sentAt":"2013-06-07T15:13:13Z","receivedAt":"2013-06-07T15:13:13Z","isPatch":true,"sender":{"key":"r@artagnon.com","avatar":"https://avatars.githubusercontent.com/u/37226?v=4"},"body":"Junio C Hamano wrote:\n> How about this?\n\nLooks good, thanks.\n"}]}