From: Jeff King <peff@peff.net>
Date: Tue, 12 Nov 2013 08:38:38 GMT
Subject: Re: [PATCH 2/4] Emphasize options and force ASCIIDOC escaping of "--"
Message-ID: <20131112083838.GB1684@sigill.intra.peff.net>
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