Thread (5 messages) flat view 5 messages, 3 authors, 2017-09-28

Re: [PATCH] doc: correct command formatting

From: Jonathan Nieder <hidden>
Date: 2017-09-28 19:34:20

Hi,

Andreas Heiduk wrote:
+1, Thanks for spotting.
Thanks for looking it over.  Can we add your Reviewed-by?  (See [1]
for what this means.)
I did a quick

	grep -r " ` "

which came up with with another relevant place:

Documentation/git-format-patch.txt:	`--subject-prefix` option) has ` v<n>` appended to it.  E.g.

But here the space IS relevant but asciidoc does not pick up
the formatting. Perhaps that one could read like this:

	`--subject-prefix` option) has `<SPACE>v<n>` appended to it.  E.g.
Interesting.  This comes from

  commit 4aad08e061df699b49e24c4d34698d734473fb66
  Author: Junio C Hamano [off-list ref]
  Date:   Wed Jan 2 14:16:07 2013 -0800

      format-patch: document and test --reroll-count

In some output formats, the text with backticks surrounding it is
shown in a different background color, which makes something like
`{space}v<n>` tempting (with appropriate definition of {space} in
the attributes section of asciidoc.conf).  But that feels way too
subtle.

How about something like

	has a space and `v<n>` appended to it

?

Thanks,
Jonathan

[1] https://kernel.googlesource.com/pub/scm/linux/kernel/git/torvalds/linux/+/9cd6681cb1169e815c41af0265165dd1b872f228/Documentation/process/submitting-patches.rst#563
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help