threads / patch / 58056

patchrevisions.txt: escape "..." to avoid asciidoc horizontal ellipsis

Subject: [PATCH] revisions.txt: escape "..." to avoid asciidoc horizontal ellipsis

## tl;dr

2 messages between Jun 22, 2022 and Jun 22, 2022. Diffs are folded; open one to read it.

replies: 1people: 2as markdown or json

Jeff King· Jun 22, 2022, 23:33 UTC · lore

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>
---
This was originally reported via https://github.com/git/git-scm.com/issues/1700,
hence no email address for the reporter. I'm not sure if that makes it
too useless to keep, but I mostly wanted to give credit.
 Documentation/revisions.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Show changes to Documentation/revisions.txt +1 −1
diff --git a/Documentation/revisions.txt b/Documentation/revisions.txt
index f5f17b65a1..cef8c3c66f 100644
--- a/Documentation/revisions.txt
+++ b/Documentation/revisions.txt
@@ -283,7 +283,7 @@ The '..' (two-dot) Range Notation::
  for commits that are reachable from r2 excluding those that are reachable
  from r1 by '{caret}r1 r2' and it can be written as 'r1..r2'.
 
-The '...' (three-dot) Symmetric Difference Notation::
+The '\...' (three-dot) Symmetric Difference Notation::
  A similar notation 'r1\...r2' is called symmetric difference
  of 'r1' and 'r2' and is defined as
  'r1 r2 --not $(git merge-base --all r1 r2)'.

-- 
2.37.0.rc1.390.g1f5e45eb84
Junio C Hamano· Jun 22, 2022, 23:46 UTC · re: Jeff King · lore

Re: [PATCH] revisions.txt: escape "..." to avoid asciidoc horizontal ellipsis

Jeff King <peff@peff.net> writes:
Show 5 quoted lines
> 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).
Hilarious.

I just checked with "man -l -Tps" and it does seem to throw literal three dots in the PostScript.

Show 6 quoted lines
> Reported-by: Arthur Milchior
> Signed-off-by: Jeff King <peff@peff.net>
> ---
> This was originally reported via https://github.com/git/git-scm.com/issues/1700,
> hence no email address for the reporter. I'm not sure if that makes it
> too useless to keep, but I mostly wanted to give credit.

I wonder if it is the same person as <pull.1280.git.git.1655927444821.gitgitgadget@gmail.com>

Anyway, thanks, both ;-)
Show 17 quoted lines
>
>  Documentation/revisions.txt | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/revisions.txt b/Documentation/revisions.txt
> index f5f17b65a1..cef8c3c66f 100644
> --- a/Documentation/revisions.txt
> +++ b/Documentation/revisions.txt
> @@ -283,7 +283,7 @@ The '..' (two-dot) Range Notation::
>   for commits that are reachable from r2 excluding those that are reachable
>   from r1 by '{caret}r1 r2' and it can be written as 'r1..r2'.
>  
> -The '...' (three-dot) Symmetric Difference Notation::
> +The '\...' (three-dot) Symmetric Difference Notation::
>   A similar notation 'r1\...r2' is called symmetric difference
>   of 'r1' and 'r2' and is defined as
>   'r1 r2 --not $(git merge-base --all r1 r2)'.

← back to recent threads