• Jeff King's avatar
    docs: stop using asciidoc no-inline-literal · 6cf378f0
    Jeff King authored
    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 <[email protected]>` used to
        erroneously auto-generate a mailto footnote for
        [email protected]
    
      - 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: default avatarJeff King <[email protected]>
    Signed-off-by: default avatarJunio C Hamano <[email protected]>
    6cf378f0
everyday.txt 12.7 KB