git@vger.kernel.org list mirror (unofficial, one of many)
 help / color / mirror / code / Atom feed
* [PATCH] revisions.txt: escape "..." to avoid asciidoc horizontal ellipsis
@ 2022-06-22 23:33 Jeff King
  2022-06-22 23:46 ` Junio C Hamano
  0 siblings, 1 reply; 2+ messages in thread
From: Jeff King @ 2022-06-22 23:33 UTC (permalink / raw)
  To: git

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(-)

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

^ permalink raw reply	[flat|nested] 2+ messages in thread

* Re: [PATCH] revisions.txt: escape "..." to avoid asciidoc horizontal ellipsis
  2022-06-22 23:33 [PATCH] revisions.txt: escape "..." to avoid asciidoc horizontal ellipsis Jeff King
@ 2022-06-22 23:46 ` Junio C Hamano
  0 siblings, 0 replies; 2+ messages in thread
From: Junio C Hamano @ 2022-06-22 23:46 UTC (permalink / raw)
  To: Jeff King; +Cc: git

Jeff King <peff@peff.net> writes:

> 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.

> 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 ;-)

>
>  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)'.

^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2022-06-22 23:46 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-06-22 23:33 [PATCH] revisions.txt: escape "..." to avoid asciidoc horizontal ellipsis Jeff King
2022-06-22 23:46 ` Junio C Hamano

Code repositories for project(s) associated with this inbox:

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).