tech@mandoc.bsd.lv
 help / color / mirror / Atom feed
From: Steffen Nurpmeso <steffen@sdaoden.eu>
To: Ingo Schwarze <schwarze@usta.de>
Cc: tech@mdocml.bsd.lv
Subject: Re: Fwd: Small fixes for ssh.1 and ssh_config.5, OpenSSH_7.2p2
Date: Thu, 31 Mar 2016 19:11:14 +0200	[thread overview]
Message-ID: <20160331171114.eOBzGfOWc%steffen@sdaoden.eu> (raw)
In-Reply-To: <20160331162003.GF22000@athene.usta.de>

Hallo Ingo,

Ingo Schwarze <schwarze@usta.de> wrote:
 |Steffen Nurpmeso wrote on Tue, Mar 29, 2016 at 09:25:36PM +0200:
 |> i've just recognized a syntax error in some OpenSSH manuals,
 |
 |That's not a syntax error.  It cannot be one.  The esacape sequence
 |"\&" can be used at any place where any other character can be used.
 |At the worst, it could be a semantic error, but it is not even that.

I still haven't checked the OpenBSD version of OpenSSH, but i have
seen your message on their ML (via Gmane) and there you correctly
state what \& is far, it is used to avoid (mis)interpretation of "!".
So it should be before that, not thereafter.

 |> and that mandoc falsely does the correct thing, if that is possible.
 |
 |Mandoc correctly does the correct thing.

The CVS version now does.

 |

 |I'm also appending my response to your patch.

That one i meant. Let's see..

 |> -.Ic !\& Ns Ar command
 |> +.Ic \&! Ns Ar command

 |> -.Ic !\& Ns Ar command
 |> +.Ic \&! Ns Ar command

 |This patch is bogus.  Both versions are completely correct.
 |
 |The purpose of escaping in this context is to prevent mdoc(7)
 |from treating the exclamation mark as a delimiter, which can
 |influence spacing and end of sentence detection.
 |
 |The mdoc(7) language treats the argument of an mdoc macro
 |as a delimiter if both of the following conditions hold:
 |
 | 1. The macro argument consists of exactly one input character.
 | 2. That character is anyone from the following set:
 |     - opening delimiters:  ([
 |     - middle delimiters:   |
 |     - closing delimiters:  .,:;)]?!
 |
 |The usual way to escape an argument such that it isn't taken as
 |a delimiter is to add a zero-width space "\&" such that condition 1
 |no longer holds.  See the mdoc(7) manual, subsection "Delimiters",
 |for a full discussion.

Later again.

 |I admit that i usually put the "\&" in front of the character rather
 |than after it, and so do the examples in the mdoc(7) manual.  But

Fantastic.

 |some people find it more intuitive to put the "\&" afterwards to
 |express that the character is not ending a sentence (i.e. is not a
 |delimiter).

A bug.

 |I don't see the point in enforcing either style, it seems like
 |useless churn and wasted time.

The visible flyspeck in the manuals of the portable version
springs into the eye and drives you up the wall.  Bah.
Ciao,

--steffen
--
 To unsubscribe send an email to tech+unsubscribe@mdocml.bsd.lv

  reply	other threads:[~2016-03-31 17:11 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-03-29 19:25 Steffen Nurpmeso
2016-03-29 19:44 ` Steffen Nurpmeso
2016-03-30  9:26   ` Steffen Nurpmeso
2016-03-31 16:24     ` Ingo Schwarze
2016-03-31 17:16       ` Steffen Nurpmeso
2016-03-31 16:20 ` Ingo Schwarze
2016-03-31 17:11   ` Steffen Nurpmeso [this message]
2016-03-31 17:38     ` Ingo Schwarze
2016-03-31 19:24       ` Steffen Nurpmeso
2016-03-31 20:04         ` hans
2016-04-01 12:46           ` Steffen Nurpmeso
2016-04-01 12:53             ` hans

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20160331171114.eOBzGfOWc%steffen@sdaoden.eu \
    --to=steffen@sdaoden.eu \
    --cc=schwarze@usta.de \
    --cc=tech@mdocml.bsd.lv \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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 NNTP newsgroup(s).