revisions.txt: escape "..." to avoid asciidoc horizontal ellipsis
commit5fd9d1738e0f2a38e30141faf18f566d4c6e9c05
authorJeff King <peff@peff.net>
Wed, 22 Jun 2022 23:33:04 +0000 (22 19:33 -0400)
committerJunio C Hamano <gitster@pobox.com>
Wed, 22 Jun 2022 23:49:45 +0000 (22 16:49 -0700)
tree9fb851161ca882e1ffa61f5da0be206553f9a14a
parentdc8c8deaa6b5847733bd7df011a4c7b7d1a64e0a
revisions.txt: escape "..." to avoid asciidoc horizontal ellipsis

In asciidoc's HTML output of the "gitrevisions" and "git-rev-parse"
documentation, the header:

  The ... (three-dot) Symmetric Difference Notation

is rendered using "&8230;", a horizontal ellipsis. This is visually
ugly, but also hard to search for or cut-and-paste. We really mean three
ascii dots (0x2e) here, so let's make sure it renders as such.

The simplest way to do that is just escaping the leading dot, as the
instances in the rest of the section do. Arguably this should all be
converted to use backticks, which would let us drop the quoting here and
elsewhere (e.g., {carat}). But that does change the rendering slightly.
So let's fix the bug first, and we can decide on migrating the whole
section separately.

Note that this produces an empty doc-diff of the manpages. Curiously,
asciidoc produces the same ellipsis entity in the XML file, but docbook
then converts it back into three literal dots for the roff output! So
the roff manpages have been correct all along (which may be a reason
nobody noticed this until now).

Reported-by: Arthur Milchior
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/revisions.txt