Re: [PATCH] doc: correct command formatting

From: Jonathan Nieder <jrnieder@gmail.com>
Date: Sep 28, 2017, 19:34 UTC
Message-ID: <20170928193412.GB174074@aiede.mtv.corp.google.com>
In-Reply-To: <70decbc2-093c-9f9a-3661-ee6500cec641@gmail.com>

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.)

Show 12 quoted lines

> 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 <gitster@pobox.com>
  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