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

Re: [PATCH v2] docs: fix formatting and grammar

From
Jeff King <peff@peff.net>
Date
Jun 1, 2017, 15:53 UTC
Message-ID
<20170601155311.urqaxmjagqgiogmh@sigill.intra.peff.net>
In-Reply-To
<20170601103703.12216-1-adam@dinwoodie.org>
On Thu, Jun 01, 2017 at 11:37:03AM +0100, Adam Dinwoodie wrote:
Show 20 quoted lines
> When compiling the documentation, asciidoc thinks a backtick surrounded
> by whitespace shouldn't be interpreted as marking the start or end of a
> literal.  In most cases, that's useful behaviour, but in the git-pull
> documentation it means asciidoc is failing to correctly detect which
> text should be monospaced and which shouldn't.
> 
> To avoid this, remove the extraneous spaces from the text to be
> monospaced.  It would also be possible to fix the formatting by
> switching to asciidoc's ++ monospace format markers and still have the
> space characters included in the monospace text, but the spaces aren't
> necessary and not having them keeps the markup simpler.
> 
> Also include a minor grammar fix suggested by Jeff while we're changing
> these lines.
> 
> Signed-off-by: Adam Dinwoodie <adam@dinwoodie.org>
> Helped-by: Jeff King <peff@peff.net>
> ---
>  Documentation/git-pull.txt | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
This looks fine, although...
Show 5 quoted lines
>  In order to determine what URL to use to fetch from, the value
>  of the configuration `remote.<origin>.url` is consulted
> -and if there is not any such variable, the value on `URL: ` line
> +and if there is not any such variable, the value on the `URL:` line
>  in `$GIT_DIR/remotes/<origin>` file is used.

...I should have read to the end of the sentence. It should also be "in the `$GIT_DIR/remotes/<origin>` file". Or just drop "file".

-Peff
Previous: Adam DinwoodieNext: Junio C Hamano
Message 6 of 8 in “docs: fix literal quoted spaces”
  1. docs: fix literal quoted spacesAdam Dinwoodie, May 31, 2017
  2. Jeff KingMay 31, 2017
  3. Junio C HamanoJun 1, 2017
  4. Adam DinwoodieJun 1, 2017
  5. docs: fix formatting and grammarAdam Dinwoodie, Jun 1, 2017
  6. Jeff KingJun 1, 2017
  7. Junio C HamanoJun 2, 2017
  8. Jeff KingJun 2, 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.