Re: [PATCH] doc: correct command formatting

Am 28.09.2017 um 21:34 schrieb Jonathan Nieder:

Andreas Heiduk wrote:

quoted

+1, Thanks for spotting.

Thanks for looking it over.  Can we add your Reviewed-by?  (See [1]
for what this means.)

Well, I'd like to see the following occurrence of the same problem
solved in that patch, too. Beyond that - your welcome.

quoted

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.

...

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

Well, in the original text "<n>" is already used as a replacement
marker. Therefore "<space>" seemed obvious to me as another replacement
marker which avoids exactly that problem.

?

Thanks,
Jonathan

[1] https://kernel.googlesource.com/pub/scm/linux/kernel/git/torvalds/linux/+/9cd6681cb1169e815c41af0265165dd1b872f228/Documentation/process/submitting-patches.rst#563