discuss@mandoc.bsd.lv
 help / color / mirror / Atom feed
From: Ingo Schwarze <schwarze@usta.de>
To: discuss@mdocml.bsd.lv
Subject: Re: desired .Bk semantics?
Date: Sat, 3 Jul 2010 19:28:42 +0200	[thread overview]
Message-ID: <20100703172842.GE4327@iris.usta.de> (raw)
In-Reply-To: <4C2F644F.3070307@bsd.lv>

Hi Kristaps,

Kristaps Dzonsons wrote on Sat, Jul 03, 2010 at 06:24:47PM +0200:

> I propose the following.  I've enclosed a patch that demonstrates this.
> First, I disabled `Bk' completely.

I disagree: That is going too far.

Like that, you lose the possibility to keep non-optional arguments
together on the same line.  Consider, e.g.

.Nm cut
.Bk -words
.Fl b Ar list
.Ek
.Op Ar n
.Op Ar
.Nm cut
.Bk -words
.Fl c Ar list
.Ek
.Ar

I admit in this case this is not critical because the keep is near
the beginning of the line, but this is how it should be written,
and such necessities can also arise later on the line,

Thus, do not rip .Bk out completely.
It should be available for the rare cases where is is needed,
and it is a standard mdoc(7) macro we cannot just drop.

> Second, when `Op' or `Oo' is encountered with MDOC_SYNPRETTY (i.e., in a
> SYNOPSIS section or with ".nr nS 1"), spaces are made non-breaking.

I disagree: That is going too far.

Like that, you lose the option to allow breaking in the middle of
an .Op or .Oo group.  Consider, e.g.

.Nm openssl
.Cm gendsa
.Oo
.Fl aes128 |
.Fl aes192 |
.Fl aes256 |
.Fl des |
.Fl des3
.Oc
...

This could get worse when more ciphers are implemented, and ultimately,
it won't fit on one line any more, giving you very ugly output and no way
to fix it.

I don't oppose automatically assuming implied .Bk around .Op and .Oo
tough, as long as they are on one input line, even though troff
historically decided against that.

That's probably the last mail i can send before teardown of the hack
room, and i don't have time to look at your code right now...

Yours,
  Ingo
--
 To unsubscribe send an email to discuss+unsubscribe@mdocml.bsd.lv

      parent reply	other threads:[~2010-07-03 17:28 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2010-07-02 23:43 Ingo Schwarze
2010-07-03  6:54 ` Jason McIntyre
2010-07-03 12:27   ` Kristaps Dzonsons
2010-07-03 14:11     ` Jason McIntyre
2010-07-03 16:24       ` Kristaps Dzonsons
2010-07-03 16:52         ` Jason McIntyre
2010-07-03 17:25           ` desired .Bk semantics? [UPDATED PATCH] Kristaps Dzonsons
2010-07-03 17:28         ` Ingo Schwarze [this message]

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=20100703172842.GE4327@iris.usta.de \
    --to=schwarze@usta.de \
    --cc=discuss@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).