Thread (1 message) 1 message, 1 author, 2016-06-15

Re: [PATCH] fetch doc: escape asterisk in --tags paragraph

From: Junio C Hamano <hidden>
Date: 2016-06-15 22:57:35

Ramkumar Ramachandra [off-list ref] writes:
Currently, the paragraph corresponding to the --tags option in
git-fetch(1) looks like:

  -t, --tags
      This is a short-hand for giving "refs/tags/:refs/tags/" refspec
                                                 ^^^^^^^^^^^
						 this is in bold

This happens because the corresponding text in fetch-options.txt is
"refs/tags/*:refs/tags/*"; asciidoc renders the text between the two
asterisks in bold.  Escape the first asterisk, correcting the text.

Signed-off-by: Ramkumar Ramachandra <redacted>
---
 Candidate for maint?
The issue certainly is real and needs a fix for maint.  Your
solution I am not sure about.

  $ git grep '\\\*' -- Documentation/\*.txt

shows only two meaningful hits (git-rm.txt and git-svn.txt);
everybody else uses

$ git grep '{asterisk}' -- Documentation/\*.txt

and the one you spotted in fetch-options.txt is very similar to the
one appears in git-pull.txt, I think.

quoted hunk
 Documentation/fetch-options.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Documentation/fetch-options.txt b/Documentation/fetch-options.txt
index 9cb6496..5f68149 100644
--- a/Documentation/fetch-options.txt
+++ b/Documentation/fetch-options.txt
@@ -61,7 +61,7 @@ endif::git-pull[]
 ifndef::git-pull[]
 -t::
 --tags::
-	This is a short-hand for giving "refs/tags/*:refs/tags/*"
+	This is a short-hand for giving "refs/tags/\*:refs/tags/*"
 	refspec from the command line, to ask all tags to be fetched
 	and stored locally.  Because this acts as an explicit
 	refspec, the default refspecs (configured with the
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help