All of lore.kernel.org
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: "Jason St. John" <jstjohn@purdue.edu>
Cc: git@vger.kernel.org
Subject: Re: [PATCH 2/4] Emphasize options and force ASCIIDOC escaping of "--"
Date: Mon, 11 Nov 2013 10:06:23 -0800	[thread overview]
Message-ID: <xmqq8uwun78g.fsf@gitster.dls.corp.google.com> (raw)
In-Reply-To: <1383958133-4207-1-git-send-email-jstjohn@purdue.edu> (Jason St. John's message of "Fri, 8 Nov 2013 19:48:51 -0500")

"Jason St. John" <jstjohn@purdue.edu> writes:

> 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:

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

  parent reply	other threads:[~2013-11-11 18:06 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-11-09  0:48 [PATCH 2/4] Emphasize options and force ASCIIDOC escaping of "--" Jason St. John
2013-11-09  0:48 ` [PATCH 3/4] Correct word usage of "timezone" in "Documentation" directory Jason St. John
2013-11-12 18:40   ` Junio C Hamano
2013-11-09  0:48 ` [PATCH 4/4] Correct word usage of "timezone" in "Documentation/RelNotes" directory Jason St. John
2013-11-09  1:02   ` Jonathan Nieder
2013-11-09  8:13 ` [PATCH 2/4] Emphasize options and force ASCIIDOC escaping of "--" Johannes Sixt
2013-11-11 18:06 ` Junio C Hamano [this message]
2013-11-12  8:38 ` Jeff King

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=xmqq8uwun78g.fsf@gitster.dls.corp.google.com \
    --to=gitster@pobox.com \
    --cc=git@vger.kernel.org \
    --cc=jstjohn@purdue.edu \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.