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
Jeff King <peff@peff.net>
Date
Nov 12, 2013, 08:38 UTC
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:
Show 6 quoted lines
>  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
Previous: Junio C Hamano
Message 8 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.