git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH] doc: correct command formatting

From
Andreas Heiduk <asheiduk@gmail.com>
Date
Sep 28, 2017, 22:28 UTC
Message-ID
<0635cfc6-e5ce-c0eb-d0e4-636fb57fbe4f@gmail.com>
In-Reply-To
<20170928193412.GB174074@aiede.mtv.corp.google.com>
Am 28.09.2017 um 21:34 schrieb Jonathan Nieder:
Show 6 quoted lines
> Andreas Heiduk wrote:
> 
>> +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.

Show 7 quoted lines
>>
>> 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.
...
Show 9 quoted lines
> 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.

Show 8 quoted lines
> 
> ?
> 
> Thanks,
> Jonathan
> 
> [1] https://kernel.googlesource.com/pub/scm/linux/kernel/git/torvalds/linux/+/9cd6681cb1169e815c41af0265165dd1b872f228/Documentation/process/submitting-patches.rst#563
> 
Previous: Jonathan NiederNext: Junio C Hamano
Message 4 of 8 in “doc: correct command formatting”
  1. doc: correct command formattingAdam Dinwoodie, Sep 28, 2017
  2. Andreas HeidukSep 28, 2017
  3. Jonathan NiederSep 28, 2017
  4. Andreas HeidukSep 28, 2017
  5. Junio C HamanoSep 29, 2017
  6. Jonathan NiederSep 29, 2017
  7. Junio C HamanoSep 29, 2017
  8. Jonathan NiederSep 28, 2017

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.