discuss@mandoc.bsd.lv
 help / color / mirror / Atom feed
From: Ingo Schwarze <schwarze@usta.de>
To: Thomas Klausner <wiz@NetBSD.org>
Cc: discuss@mdocml.bsd.lv
Subject: Re: Space after .E[dl...]?
Date: Wed, 23 Nov 2011 01:31:19 +0100	[thread overview]
Message-ID: <20111123003118.GA24880@iris.usta.de> (raw)
In-Reply-To: <20111122223416.GY9000@danbala.tuwien.ac.at>

Hi Thomas,

Thomas Klausner wrote on Tue, Nov 22, 2011 at 11:34:16PM +0100:

> groff by default doesn't add space after a Bd/Ed, Bl/El etc.
> Many man page authors do like to have one there though
> and add a Pp for this reason.
> 
> I think that Bd/Ed etc should have a space by default afterwards
> (like before the block); except perhaps when used with -compact.
> 
> Opinions?

Maybe that would have been better design.
I'm not completely sure that i don't miss good reasons for the
established behaviour, but your idea does seem more natural to
me than what we have now.

However, this is not just a question of what we like better,
but also a question of compatibility.  There are three aspects
to compatibility:

(1) At the very least, if we were to change this, groff and
mandoc would have to change at the same time.  This is clearly
not a good point to introduce a groff-mandoc difference.
Currently, it is not easy to push changes into the groff
mainline.  Werner Lemberg, the groff technical lead, is
overworked, and while he does take care of critical stuff and
also some of the less important things that seem interesting
to him, he does not respond to all suggestions.  No other groff
committer takes the initiative when it comes to changing
established behaviour, unless my impressions during the last
year or so are quite wrong.

(2) Even if we would manage to write patches for groff and
mandoc and get them into both trees, we have to consider that
people writing new or editing existing manuals will start
relying on the new behaviour, and such manuals will look bad
with older formatters, for example on Solaris.  For that reason,
if the existing behaviour has been consistent for a very long
time on almost all mdoc(7) implementations, i'd be rather
hesitant to change it now.  On the other hand, if existing
older implementations were inconsistent with one another
anyway, this item (2) wouldn't be a relevant point.  Note that
i have still not come round to tracking down, installing, and
testing legacy mdoc(7) implementations, such that i have no
idea which kinds of changes would be how disrupting.  Before
setting out to change the language, i'd consider it important
to have a good understanding of such questions.  However, right
now, i still see much more important issues to work on than
investigating compatibility with legacy mdoc(7) implementations
and trying to polish the language definition.

(3) There are thousands of real-world manuals written for the
old behaviour.  Quite probably, there are some that will look
worse after the change because the additional blank line is not
an improvement in their particular case, even if it is in many
other cases, and the authors of course relied on the fact that
there is no blank line.  Before even proposing this change in
the language definition, i'd like some rough estimate, or at
least feeling, how many pages might be affected by this effect,
and how much effort we are imposing on people like jmc@ to
clean up the tree after the change.

In short, i think this is much less trivial than it may seem,
and i'm not that thrilled about the idea, unless somebody else
is going to do all the work outlined above.

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

  reply	other threads:[~2011-11-23  0:31 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-11-22 22:34 Thomas Klausner
2011-11-23  0:31 ` Ingo Schwarze [this message]
2011-11-23 12:54   ` Thomas Klausner
2011-11-23 23:54     ` Ingo Schwarze

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=20111123003118.GA24880@iris.usta.de \
    --to=schwarze@usta.de \
    --cc=discuss@mdocml.bsd.lv \
    --cc=wiz@NetBSD.org \
    /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).