Re: [PATCH 2/4] Emphasize options and force ASCIIDOC escaping of "--"
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=` limits to commits newer than ``, and using it > -with `--grep=` further limits to commits whose log message > +'\--since=' limits to commits newer than ``, and using it > +with '\--grep=' further limits to commits whose log message > has a line that matches ``), 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 -- To unsubscribe from this list: send the line "unsubscribe git" in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
Re: [PATCH 2/4] Emphasize options and force ASCIIDOC escaping of "--"
"Jason St. John" 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.
--
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majord...@vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
Re: [PATCH 2/4] Emphasize options and force ASCIIDOC escaping of "--"
Am 09.11.2013 01:48, schrieb Jason St. John: > -`--since=` limits to commits newer than ``, and using it > -with `--grep=` further limits to commits whose log message > +'\--since=' limits to commits newer than ``, and using it > +with '\--grep=' further limits to commits whose log message I don't think this kind of change goes in the right direction. Currently, the general style seems to be that options are typeset in monospaced font. I looked at git-merge and git-rebase (and git-log, of course). But after your change, they are typeset in italics, in the HTML version of the manual pages. I did not find an advice on the preferred formatting, though, except for the last sentence in Documentation/CodingGuidelines. -- Hannes -- To unsubscribe from this list: send the line "unsubscribe git" in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
