mirror of
https://github.com/git/git
synced 2024-09-13 05:14:36 +00:00
6cf378f0cb
In asciidoc 7, backticks like `foo` produced a typographic
effect, but did not otherwise affect the syntax. In asciidoc
8, backticks introduce an "inline literal" inside which markup
is not interpreted. To keep compatibility with existing
documents, asciidoc 8 has a "no-inline-literal" attribute to
keep the old behavior. We enabled this so that the
documentation could be built on either version.
It has been several years now, and asciidoc 7 is no longer
in wide use. We can now decide whether or not we want
inline literals on their own merits, which are:
1. The source is much easier to read when the literal
contains punctuation. You can use `master~1` instead
of `master{tilde}1`.
2. They are less error-prone. Because of point (1), we
tend to make mistakes and forget the extra layer of
quoting.
This patch removes the no-inline-literal attribute from the
Makefile and converts every use of backticks in the
documentation to an inline literal (they must be cleaned up,
or the example above would literally show "{tilde}" in the
output).
Problematic sites were found by grepping for '`.*[{\\]' and
examined and fixed manually. The results were then verified
by comparing the output of "html2text" on the set of
generated html pages. Doing so revealed that in addition to
making the source more readable, this patch fixes several
formatting bugs:
- HTML rendering used the ellipsis character instead of
literal "..." in code examples (like "git log A...B")
- some code examples used the right-arrow character
instead of '->' because they failed to quote
- api-config.txt did not quote tilde, and the resulting
HTML contained a bogus snippet like:
<tt><sub></tt> foo <tt></sub>bar</tt>
which caused some parsers to choke and omit whole
sections of the page.
- git-commit.txt confused ``foo`` (backticks inside a
literal) with ``foo'' (matched double-quotes)
- mentions of `A U Thor <author@example.com>` used to
erroneously auto-generate a mailto footnote for
author@example.com
- the description of --word-diff=plain incorrectly showed
the output as "[-removed-] and {added}", not "{+added+}".
- using "prime" notation like:
commit `C` and its replacement `C'`
confused asciidoc into thinking that everything between
the first backtick and the final apostrophe were meant
to be inside matched quotes
- asciidoc got confused by the escaping of some of our
asterisks. In particular,
`credential.\*` and `credential.<url>.\*`
properly escaped the asterisk in the first case, but
literally passed through the backslash in the second
case.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
|
||
|---|---|---|
| .. | ||
| .gitignore | ||
| api-allocation-growing.txt | ||
| api-argv-array.txt | ||
| api-builtin.txt | ||
| api-config.txt | ||
| api-credentials.txt | ||
| api-decorate.txt | ||
| api-diff.txt | ||
| api-directory-listing.txt | ||
| api-gitattributes.txt | ||
| api-grep.txt | ||
| api-hash.txt | ||
| api-history-graph.txt | ||
| api-in-core-index.txt | ||
| api-index-skel.txt | ||
| api-index.sh | ||
| api-lockfile.txt | ||
| api-merge.txt | ||
| api-object-access.txt | ||
| api-parse-options.txt | ||
| api-quote.txt | ||
| api-ref-iteration.txt | ||
| api-remote.txt | ||
| api-revision-walking.txt | ||
| api-run-command.txt | ||
| api-setup.txt | ||
| api-sha1-array.txt | ||
| api-sigchain.txt | ||
| api-strbuf.txt | ||
| api-string-list.txt | ||
| api-tree-walking.txt | ||
| api-xdiff-interface.txt | ||
| index-format.txt | ||
| pack-format.txt | ||
| pack-heuristics.txt | ||
| pack-protocol.txt | ||
| protocol-capabilities.txt | ||
| protocol-common.txt | ||
| racy-git.txt | ||
| send-pack-pipeline.txt | ||
| shallow.txt | ||
| trivial-merge.txt | ||