[4887] in arla-drinkers
patch: improve mdoc(7) syntax in arlad.8
daemon@ATHENA.MIT.EDU (Ingo Schwarze)
Wed Feb 24 06:26:49 2010
From arla-drinkers-bounces@stacken.kth.se Wed Feb 24 11:26:49 2010
Return-Path: <arla-drinkers-bounces@stacken.kth.se>
Delivered-To: arla-drinkers-mtg@bloom-picayune.mit.edu
Received: (qmail 9810 invoked from network); 24 Feb 2010 11:26:48 -0000
Received: from mx2.kth.se (130.237.48.98)
by charon.mit.edu with SMTP; 24 Feb 2010 11:26:48 -0000
X-KTH-mail-from: arla-drinkers-bounces@stacken.kth.se
Received: from localhost (localhost [127.0.0.1])
by mx2.kth.se (Postfix) with ESMTP id 7218D10A986;
Wed, 24 Feb 2010 12:26:47 +0100 (CET)
X-Virus-Scanned: by amavisd-new at kth.se
Received: from mx2.kth.se ([127.0.0.1])
by localhost (mx2.kth.se [127.0.0.1]) (amavisd-new, port 10024)
with LMTP id Dqthov9OpT2n; Wed, 24 Feb 2010 12:26:45 +0100 (CET)
X-KTH-mail-from: arla-drinkers-bounces@stacken.kth.se
Received: from tapas.stacken.kth.se (tapas.stacken.kth.se [130.237.234.140])
by mx2.kth.se (Postfix) with ESMTP id 77FC710AEB0;
Wed, 24 Feb 2010 12:26:29 +0100 (CET)
Received: from tapas.stacken.kth.se (localhost [127.0.0.1])
by tapas.stacken.kth.se (Postfix) with ESMTP id 9903351D5B;
Wed, 24 Feb 2010 12:26:29 +0100 (CET)
X-Original-To: arla-drinkers@tapas.stacken.kth.se
Delivered-To: arla-drinkers@tapas.stacken.kth.se
Received: from brev.stacken.kth.se (brev.stacken.kth.se [130.237.234.84])
by tapas.stacken.kth.se (Postfix) with ESMTP id F288351D5B
for <arla-drinkers@tapas.stacken.kth.se>;
Wed, 24 Feb 2010 11:28:42 +0100 (CET)
Received: from mx1.kth.se (mx1.kth.se [130.237.32.140])
by brev.stacken.kth.se (8.12.10/8.12.10) with ESMTP id o1OASg2A015436
for <arla-drinkers@stacken.kth.se>;
Wed, 24 Feb 2010 11:28:42 +0100 (MET)
X-KTH-mail-from: schwarze@usta.de
X-KTH-rcpt-to: arla-drinkers@stacken.kth.se
Received: from localhost (localhost [127.0.0.1])
by mx1.kth.se (Postfix) with ESMTP id E7006FDDAA
for <arla-drinkers@stacken.kth.se>;
Wed, 24 Feb 2010 11:28:36 +0100 (CET)
X-Virus-Scanned: by amavisd-new at kth.se
Received: from mx1.kth.se ([127.0.0.1])
by localhost (mx1.kth.se [127.0.0.1]) (amavisd-new, port 10024)
with LMTP id o8214cWxvY3t for <arla-drinkers@stacken.kth.se>;
Wed, 24 Feb 2010 11:28:34 +0100 (CET)
X-KTH-mail-from: schwarze@usta.de
X-KTH-rcpt-to: arla-drinkers@stacken.kth.se
Received: from smtp1.rz.uni-karlsruhe.de (smtp1.rz.uni-karlsruhe.de
[129.13.185.217]) by mx1.kth.se (Postfix) with ESMTP id A2E66FDDA2
for <arla-drinkers@stacken.kth.se>;
Wed, 24 Feb 2010 11:28:32 +0100 (CET)
Received: from hekate.usta.de (asta-nat.asta.uni-karlsruhe.de [172.22.63.82])
by smtp1.rz.uni-karlsruhe.de with esmtp (Exim 4.63 #1)
id 1NkE78-0005Ja-Jj; Wed, 24 Feb 2010 11:05:06 +0100
Received: from donnerwolke.usta.de ([172.24.96.3])
by hekate.usta.de with esmtp (Exim 4.71)
(envelope-from <schwarze@usta.de>)
id 1NkE78-0002A6-It; Wed, 24 Feb 2010 11:05:06 +0100
Received: from iris.usta.de ([172.24.96.5] helo=usta.de)
by donnerwolke.usta.de with esmtp (Exim 4.69)
(envelope-from <schwarze@usta.de>)
id 1NkE78-0007J9-I2; Wed, 24 Feb 2010 11:05:06 +0100
Received: from schwarze by usta.de with local (Exim 4.71)
(envelope-from <schwarze@usta.de>)
id 1NkE78-0000Xh-H2; Wed, 24 Feb 2010 11:05:06 +0100
Date: Wed, 24 Feb 2010 11:05:06 +0100
From: Ingo Schwarze <schwarze@openbsd.org>
To: arla-drinkers@stacken.kth.se
Subject: patch: improve mdoc(7) syntax in arlad.8
Message-ID: <20100224100506.GE31516@iris.usta.de>
References: <20100223205555.GE15167@iris.usta.de>
<20100223211542.GB24816@bramka.kerhand.co.uk>
<20100223222358.GI15167@iris.usta.de>
<20100224080954.GB23421@bramka.kerhand.co.uk>
MIME-Version: 1.0
Content-Disposition: inline
In-Reply-To: <20100224080954.GB23421@bramka.kerhand.co.uk>
User-Agent: Mutt/1.5.20 (2009-06-14)
X-Mailman-Approved-At: Wed, 24 Feb 2010 12:26:27 +0100
Cc: Jason McIntyre <jmc@openbsd.org>
X-BeenThere: arla-drinkers@stacken.kth.se
X-Mailman-Version: 2.1.6
Precedence: list
List-Id: Arla discussions <arla-drinkers.stacken.kth.se>
List-Unsubscribe: <https://lists.stacken.kth.se/mailman/listinfo/arla-drinkers>,
<mailto:arla-drinkers-request@stacken.kth.se?subject=unsubscribe>
List-Archive: <http://lists.stacken.kth.se/pipermail/arla-drinkers>
List-Post: <mailto:arla-drinkers@stacken.kth.se>
List-Help: <mailto:arla-drinkers-request@stacken.kth.se?subject=help>
List-Subscribe: <https://lists.stacken.kth.se/mailman/listinfo/arla-drinkers>,
<mailto:arla-drinkers-request@stacken.kth.se?subject=subscribe>
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: 7bit
Sender: arla-drinkers-bounces@stacken.kth.se
Errors-To: arla-drinkers-bounces@stacken.kth.se
Dear colleagues,
the SYNOPSIS of the arlad(8) manual page uses overlapping blocks,
i.e. the sequence .Oo Xo Oc Xc. This is a conceptual problem because
the blocks do not nest, it is not clear which block is the inner and
which is the outer one. For example, such constructs cannot be rendered
into languages like SGML or XML, and some formatters error out, e.g.
mandoc(1), see http://mdocml.bsd.lv/.
The arlad(8) manual can be fixed nicely with the patch included below.
This is based on a patch by Jason McIntyre committed to the OpenBSD
tree, and i have tweaked it such that it applies to your current
rev. 1.22 of the file.
Note that, while here, we propose to use the \*(Ba escape sequence
to represent the vertical bar at all places for consistency -
it is already used at some places.
I checked that the patch
- does not change rendering with groff-1.15
- does not change rendering with groff-1.20.1
- allows proper rendering with mandoc-1.9.15
Yours,
Ingo
--- arlad.8.orig Wed Feb 24 10:32:59 2010
+++ arlad.8 Wed Feb 24 10:38:49 2010
@@ -41,31 +41,31 @@
.Sh SYNOPSIS
.Nm
.Bk -words
-.Op Fl t | Fl -test
-.Oo Fl c Ar string \*(Ba Xo
-.Fl -conffile= Ns Ar string Oc
-.Xc
-.Oo Fl l Ar string \*(Ba Xo
-.Fl -log= Ns Ar string Oc
-.Xc
+.Op Fl t \*(Ba Fl -test
+.Oo
+.Fl c Ar string \*(Ba Fl -conffile= Ns Ar string
+.Oc
+.Oo
+.Fl l Ar string \*(Ba Fl -log= Ns Ar string
+.Oc
.Op Fl -debug= Ns Ar string
-.Oo Fl d Ar string \*(Ba Xo
-.Fl -device= Ns Ar string Oc
-.Xc
+.Oo
+.Fl d Ar string \*(Ba Fl -device= Ns Ar string
+.Oc
.Op Fl -connected-mode= Ns Ar string
-.Op Fl n | Fl -no-fork
-.Oo Fl r Ar string \*(Ba Xo
-.Fl -rxkad-level= Ns Ar string Oc
-.Xc
-.Oo Fl s Ar string \*(Ba Xo
-.Fl -sysname= Ns Ar string Oc
-.Xc
+.Op Fl n \*(Ba Fl -no-fork
+.Oo
+.Fl r Ar string \*(Ba Fl -rxkad-level= Ns Ar string
+.Oc
+.Oo
+.Fl s Ar string \*(Ba Fl -sysname= Ns Ar string
+.Oc
.Op Fl -root-volume= Ns Ar string
.Op Fl -port= Ns Ar number
-.Op Fl z | Fl -recover
+.Op Fl z \*(Ba Fl -recover
.Op Fl -cache-dir= Ns Ar string
.Op Fl -tracefile= Ns Ar filename
-.Op Fl D | -dynroot
+.Op Fl D \*(Ba -dynroot
.Op Fl -no-largefile
.Op Fl -workers= Ns Ar number
.Op Fl -cpu-usage
_______________________________________________
Arla-drinkers mailing list
Arla-drinkers@stacken.kth.se
https://lists.stacken.kth.se/mailman/listinfo/arla-drinkers
