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

Re: [PATCH 2/4] Emphasize options and force ASCIIDOC escaping of "--"

From
Junio C Hamano <gitster@pobox.com>
Date
Nov 11, 2013, 18:06 UTC
Message-ID
<xmqq8uwun78g.fsf@gitster.dls.corp.google.com>
In-Reply-To
<1383958133-4207-1-git-send-email-jstjohn@purdue.edu>
"Jason St. John" <jstjohn@purdue.edu> writes:
Show 14 quoted lines
> rev-list-options.txt: replace e.g. `--foo` with '\--foo'
> rev-list-options.txt: emphasize, instead of quote, some option arguments
>     (e.g. "foo-option" becomes 'foo-option')
> rev-list-options.txt: force ASCIIDOC escaping of "--" (e.g. '--bar'
>     becomes '\--bar')
> rev-list-options.txt: add single quote chars around options missing them
>     (e.g. --grep becomes '\--grep')
> rev-list-options.txt: replaced one instance of "regexp" with "regular
>     expressions"
> rev-list-options.txt: fix typo in "--no-walk" description ("show" -->
> "shown")
> rev-list-options.txt: replaced some instances of double quotes with
>     their ASCIIDOC equivalent (e.g. """a "-" character""" becomes
>     """a ``-'' character""",
Gaah.

Did you really have to repeat "rev-list-options.txt: " on all the lines?

> Sorry for the messy quoting in the last set of examples in the commit message.

I have a feeling that many of them can and should be turned from '--opt' to `--opt`. For example, this original:

Show 6 quoted lines
>  	Mark which side of a symmetric diff a commit is reachable from.
>  	Commits from the left side are prefixed with `<` and those from
> -	the right with `>`.  If combined with `--boundary`, those
> -	commits are prefixed with `-`.
> +	the right with `>`.  If combined with '\--boundary', those
> +	commits are prefixed with ``-''.
seems to render correctly at
    https://git-htmldocs.googlecode.com/git/git-rev-list.html
without this part of the patch.
Previous: Johannes SixtNext: Jeff King
Message 7 of 8 in “Emphasize options and force ASCIIDOC escaping of "--"”
  1. 2/4 Emphasize options and force ASCIIDOC escaping of "--"Jason St. John, Nov 9, 2013
  2. 3/4 Correct word usage of "timezone" in "Documentation" directoryJason St. John, Nov 9, 2013
  3. Junio C HamanoNov 12, 2013
  4. 4/4 Correct word usage of "timezone" in "Documentation/RelNotes" directoryJason St. John, Nov 9, 2013
  5. Jonathan NiederNov 9, 2013
  6. Johannes SixtNov 9, 2013
  7. Junio C HamanoNov 11, 2013
  8. Jeff KingNov 12, 2013

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.