git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jeff King <peff@peff.net>
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: Tue, 12 Nov 2013 03:38:38 -0500	[thread overview]
Message-ID: <20131112083838.GB1684@sigill.intra.peff.net> (raw)
In-Reply-To: <1383958133-4207-1-git-send-email-jstjohn@purdue.edu>

On Fri, Nov 08, 2013 at 07:48:51PM -0500, Jason St. John wrote:

>  Using more options generally further limits the output (e.g.
> -`--since=<date1>` limits to commits newer than `<date1>`, and using it
> -with `--grep=<pattern>` further limits to commits whose log message
> +'\--since=<date1>' limits to commits newer than `<date1>`, and using it
> +with '\--grep=<pattern>' further limits to commits whose log message
>  has a line that matches `<pattern>`), unless otherwise noted.

Others pointed out that we generally prefer the `literal` formatting for
such options (with backticks), which I agree with. If your target is
formatting manpages (and not html), you may want to build with
MAN_BOLD_LITERAL set in the Makefile, which will embolden the literals
in the output (since we cannot typeset them in a monospace font on the
terminal, as we would for html).

-Peff

      parent reply	other threads:[~2013-11-12  8:38 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
2013-11-12  8:38 ` Jeff King [this message]

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=20131112083838.GB1684@sigill.intra.peff.net \
    --to=peff@peff.net \
    --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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).