Skip to content

Commit 5fd9d17

Browse files
peffgitster
authored andcommitted
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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent dc8c8de commit 5fd9d17

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

Documentation/revisions.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -283,7 +283,7 @@ The '..' (two-dot) Range Notation::
283283
for commits that are reachable from r2 excluding those that are reachable
284284
from r1 by '{caret}r1 r2' and it can be written as 'r1..r2'.
285285

286-
The '...' (three-dot) Symmetric Difference Notation::
286+
The '\...' (three-dot) Symmetric Difference Notation::
287287
A similar notation 'r1\...r2' is called symmetric difference
288288
of 'r1' and 'r2' and is defined as
289289
'r1 r2 --not $(git merge-base --all r1 r2)'.

0 commit comments

Comments
 (0)