remove .Xr spacing tweak

remove .Xr spacing tweak

[Ingo Schwarze]

Hi,

i think it is time to remove an OpenBSD-specific tweak from the .Xr
handling in OpenBSD mandoc(1) and make it compatible with bsd.lv
mandoc and with groff-1.21.
Right now, OpenBSD assumes an implicit .Ns after .Xr's second
argument, if more non-punctuation arguments follow.

This tweak in mdoc_macro.c was originally added for compatibility
with groff-1.15, which is now gone for some time.

The patch also scours the base tree, adapting those pages where
the rendering would change.

OK?
  Ingo


Index: usr.bin/mandoc/mdoc_macro.c
===================================================================
RCS file: /cvs/src/usr.bin/mandoc/mdoc_macro.c,v
retrieving revision 1.70
diff -u -p -r1.70 mdoc_macro.c
--- usr.bin/mandoc/mdoc_macro.c	16 Oct 2011 12:18:32 -0000	1.70
+++ usr.bin/mandoc/mdoc_macro.c	3 Dec 2011 18:05:43 -0000
@@ -1552,19 +1563,6 @@ in_line_argn(MACRO_PROT_ARGS)
 			if ( ! rew_elem(m, tok))
 				return(0);
 			flushed = 1;
-		}
-
-		/* 
-		 * XXX: this is a hack to work around groff's ugliness
-		 * as regards `Xr' and extraneous arguments.  It should
-		 * ideally be deprecated behaviour, but because this is
-		 * code is no here, it's unlikely to be removed.
-		 */
-		if (MDOC_Xr == tok && j == maxargs) {
-			if ( ! mdoc_elem_alloc(m, line, la, MDOC_Ns, NULL))
-				return(0);
-			if ( ! rew_elem(m, MDOC_Ns))
-				return(0);
 		}
 
 		if ( ! dword(m, line, la, p, DELIM_MAX))
Index: kerberosV/src/kdc/hprop.8
===================================================================
RCS file: /cvs/src/kerberosV/src/kdc/hprop.8,v
retrieving revision 1.4
diff -u -p -r1.4 hprop.8
--- kerberosV/src/kdc/hprop.8	14 Apr 2006 08:15:03 -0000	1.4
+++ kerberosV/src/kdc/hprop.8	3 Dec 2011 18:05:43 -0000
@@ -185,7 +185,7 @@ Deprecated, identical to
 .Sh EXAMPLES
 The following will propagate a database to another machine (which
 should run
-.Xr hpropd 8 ):
+.Xr hpropd 8 ) :
 .Bd -literal -offset indent
 $ hprop slave-1 slave-2
 .Ed
Index: lib/libc/sys/reboot.2
===================================================================
RCS file: /cvs/src/lib/libc/sys/reboot.2,v
retrieving revision 1.14
diff -u -p -r1.14 reboot.2
--- lib/libc/sys/reboot.2	12 Sep 2008 05:15:54 -0000	1.14
+++ lib/libc/sys/reboot.2	3 Dec 2011 18:05:43 -0000
@@ -92,7 +92,7 @@ even if
 .Dv RB_HALT
 is not specified.
 This is because
-.Xr panic 9 s
+.Xr panic 9 Ns s
 during startup will probably just repeat on the next boot.
 Use of this option implies that the user has requested the action
 specified (for example, using the
Index: libexec/ld.so/ld.so.1
===================================================================
RCS file: /cvs/src/libexec/ld.so/ld.so.1,v
retrieving revision 1.17
diff -u -p -r1.17 ld.so.1
--- libexec/ld.so/ld.so.1	24 Aug 2008 20:43:53 -0000	1.17
+++ libexec/ld.so/ld.so.1	3 Dec 2011 18:05:43 -0000
@@ -123,7 +123,7 @@ the absolute pathnames of all objects, t
 When set, these variables are interpreted as format strings a la
 .Xr printf 3
 to customize the trace output and are used by
-.Xr ldd 1 's
+.Xr ldd 1 Ns 's
 .Fl f
 option and allows
 .Xr ldd 1
Index: libexec/makewhatis/makewhatis.8
===================================================================
RCS file: /cvs/src/libexec/makewhatis/makewhatis.8,v
retrieving revision 1.18
diff -u -p -r1.18 makewhatis.8
--- libexec/makewhatis/makewhatis.8	2 Mar 2011 07:48:22 -0000	1.18
+++ libexec/makewhatis/makewhatis.8	3 Dec 2011 18:05:43 -0000
@@ -60,7 +60,7 @@ for use with
 .Xr apropos 1 ,
 .Xr whatis 1 ,
 and
-.Xr man 1 's
+.Xr man 1 Ns 's
 .Fl k
 option.
 If
Index: sbin/fsdb/fsdb.8
===================================================================
RCS file: /cvs/src/sbin/fsdb/fsdb.8,v
retrieving revision 1.17
diff -u -p -r1.17 fsdb.8
--- sbin/fsdb/fsdb.8	26 Jun 2008 05:42:06 -0000	1.17
+++ sbin/fsdb/fsdb.8	3 Dec 2011 18:05:44 -0000
@@ -61,7 +61,7 @@ The options are as follows:
 .Bl -tag -width Ds
 .It Fl d
 Enables additional debugging output (which comes primarily from
-.Xr fsck 8 -derived
+.Xr fsck 8 Ns -derived
 code).
 .It Fl f Ar fsname
 Open file system
Index: share/man/man4/gif.4
===================================================================
RCS file: /cvs/src/share/man/man4/gif.4,v
retrieving revision 1.24
diff -u -p -r1.24 gif.4
--- share/man/man4/gif.4	24 Nov 2009 19:13:07 -0000	1.24
+++ share/man/man4/gif.4	3 Dec 2011 18:05:44 -0000
@@ -61,7 +61,7 @@ For all six modes the
 interface must be configured with the
 addresses used for the outer header.
 This can be done by using
-.Xr ifconfig 8 's
+.Xr ifconfig 8 Ns 's
 .Ic tunnel
 command (which uses the
 .Dv SIOCSIFPHYADDR
Index: share/man/man4/lc.4
===================================================================
RCS file: /cvs/src/share/man/man4/lc.4,v
retrieving revision 1.11
diff -u -p -r1.11 lc.4
--- share/man/man4/lc.4	26 Jun 2008 05:42:06 -0000	1.11
+++ share/man/man4/lc.4	3 Dec 2011 18:05:44 -0000
@@ -49,7 +49,7 @@ The EtherWORKS III series supports vario
 on model.
 Some models also support media autoselect.
 Media is selected with
-.Xr ifconfig 8 's
+.Xr ifconfig 8 Ns 's
 .Sq media
 directive.
 .Sh SEE ALSO
Index: share/man/man4/netintro.4
===================================================================
RCS file: /cvs/src/share/man/man4/netintro.4,v
retrieving revision 1.40
diff -u -p -r1.40 netintro.4
--- share/man/man4/netintro.4	29 Jan 2009 19:35:27 -0000	1.40
+++ share/man/man4/netintro.4	3 Dec 2011 18:05:44 -0000
@@ -182,7 +182,7 @@ A user process (or possibly multiple co-
 maintains this database by sending messages over a special kind
 of socket.
 This supplants fixed-size
-.Xr ioctl 2 's
+.Xr ioctl 2 Ns s
 used in earlier releases.
 .Pp
 This facility is described in
Index: share/man/man4/sm.4
===================================================================
RCS file: /cvs/src/share/man/man4/sm.4,v
retrieving revision 1.17
diff -u -p -r1.17 sm.4
--- share/man/man4/sm.4	26 Jun 2008 05:42:07 -0000	1.17
+++ share/man/man4/sm.4	3 Dec 2011 18:05:44 -0000
@@ -96,7 +96,7 @@ To enable the AUI media, select the
 or
 .Em aui
 media type with
-.Xr ifconfig 8 's
+.Xr ifconfig 8 Ns 's
 .Sq media
 directive.
 To select UTP, select the
Index: share/man/man4/we.4
===================================================================
RCS file: /cvs/src/share/man/man4/we.4,v
retrieving revision 1.14
diff -u -p -r1.14 we.4
--- share/man/man4/we.4	26 Jun 2008 05:42:07 -0000	1.14
+++ share/man/man4/we.4	3 Dec 2011 18:05:44 -0000
@@ -81,7 +81,7 @@ To enable the AUI media, select the
 or
 .Em aui
 media type with
-.Xr ifconfig 8 's
+.Xr ifconfig 8 Ns 's
 .Sq media
 directive.
 To select the other media (transceiver), select the
Index: share/man/man4/man4.sparc/mgx.4
===================================================================
RCS file: /cvs/src/share/man/man4/man4.sparc/mgx.4,v
retrieving revision 1.12
diff -u -p -r1.12 mgx.4
--- share/man/man4/man4.sparc/mgx.4	3 Sep 2011 22:59:07 -0000	1.12
+++ share/man/man4/man4.sparc/mgx.4	3 Dec 2011 18:05:44 -0000
@@ -52,7 +52,7 @@ interface.
 The MGX and MGXPlus frame buffers will adapt their resolution to the monitor
 they are connected to.
 However, when not connected to a Sun monitor, the device will default to the
-.Xr cgthree 4 -compatible
+.Xr cgthree 4 Ns -compatible
 1152x900 resolution, with a refresh rate of 66Hz.
 A different resolution can be forced using the set of DIP switches
 .Pq sometimes covered by metal foil
Index: share/man/man4/man4.sparc/tvtwo.4
===================================================================
RCS file: /cvs/src/share/man/man4/man4.sparc/tvtwo.4,v
retrieving revision 1.17
diff -u -p -r1.17 tvtwo.4
--- share/man/man4/man4.sparc/tvtwo.4	3 Sep 2011 22:59:07 -0000	1.17
+++ share/man/man4/man4.sparc/tvtwo.4	3 Dec 2011 18:05:44 -0000
@@ -50,7 +50,7 @@ interface.
 The XVideo and PowerVideo frame buffers will adapt their resolution and
 refresh rate to the monitor they are connected to.
 However, when not connected to a Sun monitor, the device will default to the
-.Xr cgthree 4 -compatible
+.Xr cgthree 4 Ns -compatible
 1152x900 resolution, with a refresh rate of 67Hz.
 A different resolution can be forced using the rotary switch on the edge
 of the board.
Index: share/man/man4/man4.sparc64/mgx.4
===================================================================
RCS file: /cvs/src/share/man/man4/man4.sparc64/mgx.4,v
retrieving revision 1.13
diff -u -p -r1.13 mgx.4
--- share/man/man4/man4.sparc64/mgx.4	3 Sep 2011 22:59:07 -0000	1.13
+++ share/man/man4/man4.sparc64/mgx.4	3 Dec 2011 18:05:44 -0000
@@ -52,7 +52,7 @@ interface.
 The MGX and MGXPlus frame buffers will adapt their resolution to the monitor
 they are connected to.
 However, when not connected to a Sun monitor, the device will default to the
-.Xr cgthree 4 -compatible
+.Xr cgthree 4 Ns -compatible
 1152x900 resolution, with a refresh rate of 66Hz.
 A different resolution can be forced using the set of DIP switches
 .Pq sometimes covered by metal foil
Index: share/man/man4/man4.sparc64/tvtwo.4
===================================================================
RCS file: /cvs/src/share/man/man4/man4.sparc64/tvtwo.4,v
retrieving revision 1.10
diff -u -p -r1.10 tvtwo.4
--- share/man/man4/man4.sparc64/tvtwo.4	3 Sep 2011 22:59:07 -0000	1.10
+++ share/man/man4/man4.sparc64/tvtwo.4	3 Dec 2011 18:05:44 -0000
@@ -50,7 +50,7 @@ interface.
 The XVideo and PowerVideo frame buffers will adapt their resolution and
 refresh rate to the monitor they are connected to.
 However, when not connected to a Sun monitor, the device will default to the
-.Xr cgthree 4 -compatible
+.Xr cgthree 4 Ns -compatible
 1152x900 resolution, with a refresh rate of 67Hz.
 A different resolution can be forced using the rotary switch on the edge
 of the board.
Index: share/man/man5/bsd.port.mk.5
===================================================================
RCS file: /cvs/src/share/man/man5/bsd.port.mk.5,v
retrieving revision 1.309
diff -u -p -r1.309 bsd.port.mk.5
--- share/man/man5/bsd.port.mk.5	25 Nov 2011 14:04:23 -0000	1.309
+++ share/man/man5/bsd.port.mk.5	3 Dec 2011 18:05:45 -0000
@@ -2046,8 +2046,9 @@ User-settings.
 Defaults to
 .Sq Yes .
 Forces commands like
-.Xr ftp 1 ,
-.Xr pkg_create 1 ...
+.Xr ftp 1
+and
+.Xr pkg_create 1
 to use their progress-meter even in the absence of a terminal.
 .It Ev PROPERTIES
 List of properties specific to a given machine architecture.
Index: sys/arch/amd64/stand/biosboot/biosboot.8
===================================================================
RCS file: /cvs/src/sys/arch/amd64/stand/biosboot/biosboot.8,v
retrieving revision 1.9
diff -u -p -r1.9 biosboot.8
--- sys/arch/amd64/stand/biosboot/biosboot.8	10 Aug 2010 20:34:16 -0000	1.9
+++ sys/arch/amd64/stand/biosboot/biosboot.8	3 Dec 2011 18:05:45 -0000
@@ -49,7 +49,7 @@ with information about the location of
 .Xr boot 8
 on disk.
 Specifically, it writes the filesystem block number of
-.Xr boot 8 's
+.Xr boot 8 Ns 's
 inode,
 the offset within this block of the inode,
 and various filesystem parameters (taken from the superblock)
@@ -124,7 +124,7 @@ may fail with any of the following error
 Too many indirect blocks.
 .Nm
 is capable of reading the direct blocks in
-.Xr boot 8 's
+.Xr boot 8 Ns 's
 inode (the location of which is patched into
 .Nm
 by
@@ -155,14 +155,14 @@ On hard disks (default filesystem block 
 .Xr boot 8
 to be over 64 MB in size!
 (Only direct blocks are required for
-.Xr boot 8 s
+.Xr boot 8 Ns s
 of up to 192 KB.)
 .It Er ERR M
 Bad magic.
 The ELF
 .Dq magic number
 \e7fELF in
-.Xr boot 8 's
+.Xr boot 8 Ns 's
 header was not found.
 This indicates that the first block of
 .Xr boot 8
Index: sys/arch/i386/stand/biosboot/biosboot.8
===================================================================
RCS file: /cvs/src/sys/arch/i386/stand/biosboot/biosboot.8,v
retrieving revision 1.23
diff -u -p -r1.23 biosboot.8
--- sys/arch/i386/stand/biosboot/biosboot.8	10 Aug 2010 20:34:16 -0000	1.23
+++ sys/arch/i386/stand/biosboot/biosboot.8	3 Dec 2011 18:05:45 -0000
@@ -49,7 +49,7 @@ with information about the location of
 .Xr boot 8
 on disk.
 Specifically, it writes the filesystem block number of
-.Xr boot 8 's
+.Xr boot 8 Ns 's
 inode,
 the offset within this block of the inode,
 and various filesystem parameters (taken from the superblock)
@@ -124,7 +124,7 @@ may fail with any of the following error
 Too many indirect blocks.
 .Nm
 is capable of reading the direct blocks in
-.Xr boot 8 's
+.Xr boot 8 Ns 's
 inode (the location of which is patched into
 .Nm
 by
@@ -155,14 +155,14 @@ On hard disks (default filesystem block 
 .Xr boot 8
 to be over 64 MB in size!
 (Only direct blocks are required for
-.Xr boot 8 s
+.Xr boot 8 Ns s
 of up to 192 KB.)
 .It Er ERR M
 Bad magic.
 The ELF
 .Dq magic number
 \e7fELF in
-.Xr boot 8 's
+.Xr boot 8 Ns 's
 header was not found.
 This indicates that the first block of
 .Xr boot 8
Index: usr.bin/jot/jot.1
===================================================================
RCS file: /cvs/src/usr.bin/jot/jot.1,v
retrieving revision 1.16
diff -u -p -r1.16 jot.1
--- usr.bin/jot/jot.1	31 May 2007 19:20:11 -0000	1.16
+++ usr.bin/jot/jot.1	3 Dec 2011 18:05:45 -0000
@@ -283,7 +283,7 @@ in the ASCII character set):
 .Dl "$ jot \-r \-c 160 a { | rs \-g0 0 8"
 .Pp
 Infinitely many
-.Xr yes 1 's
+.Xr yes 1 Ns 's
 may be obtained through:
 .Pp
 .Dl $ jot \-b yes 0
Index: usr.sbin/sensorsd/sensorsd.conf.5
===================================================================
RCS file: /cvs/src/usr.sbin/sensorsd/sensorsd.conf.5,v
retrieving revision 1.23
diff -u -p -r1.23 sensorsd.conf.5
--- usr.sbin/sensorsd/sensorsd.conf.5	15 Mar 2008 01:08:08 -0000	1.23
+++ usr.sbin/sensorsd/sensorsd.conf.5	3 Dec 2011 18:05:45 -0000
@@ -34,7 +34,7 @@ is matched by at most one entry in
 which may specify high and low limits,
 and whether sensor status changes provided by the driver should be ignored.
 If the limits are crossed or if the status provided by the driver changes,
-.Xr sensorsd 8 's
+.Xr sensorsd 8 Ns 's
 alert functionality is triggered and a command, if specified, is
 executed.
 .Pp
--
 To unsubscribe send an email to tech+unsubscribe@mdocml.bsd.lv

Re: remove .Xr spacing tweak

[Kristaps Dzonsons]

On 03/12/2011 19:16, Ingo Schwarze wrote:
> Hi,
>
> i think it is time to remove an OpenBSD-specific tweak from the .Xr
> handling in OpenBSD mandoc(1) and make it compatible with bsd.lv
> mandoc and with groff-1.21.
> Right now, OpenBSD assumes an implicit .Ns after .Xr's second
> argument, if more non-punctuation arguments follow.
>
> This tweak in mdoc_macro.c was originally added for compatibility
> with groff-1.15, which is now gone for some time.
>
> The patch also scours the base tree, adapting those pages where
> the rendering would change.

Hi Ingo,

Of course this is fine by me -- the code is #ifdef'd in my repo anyway. 
  Does this warrant a COMPATIBILITY note, as it relates to old groff 
behaviour?

Best,

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

Re: remove .Xr spacing tweak

[Ingo Schwarze]

Hi Kristaps,

Kristaps Dzonsons wrote on Sat, Dec 03, 2011 at 10:44:25PM +0100:
> On 03/12/2011 19:16, Ingo Schwarze wrote:

>>i think it is time to remove an OpenBSD-specific tweak from the .Xr
>>handling in OpenBSD mandoc(1) and make it compatible with bsd.lv
>>mandoc and with groff-1.21.
>>Right now, OpenBSD assumes an implicit .Ns after .Xr's second
>>argument, if more non-punctuation arguments follow.
>>
>>This tweak in mdoc_macro.c was originally added for compatibility
>>with groff-1.15, which is now gone for some time.
>>
>>The patch also scours the base tree, adapting those pages where
>>the rendering would change.

> Of course this is fine by me -- the code is #ifdef'd in my repo
> anyway.

It's always a pleasure to remove code bearing an XXX comment
to the effect that it is ugly and unlikely to go away.  :-)

> Does this warrant a COMPATIBILITY note, as it relates to
> old groff behaviour?

I don't think so.

  Ten-year old groff added an additional blank character to
  the output if some macro was called with more arguments
  than it normally supports; nobody was sure why, it seemed
  a bit illogical.  Maybe it was a bug, but anyway, it was
  fixed in groff half a decade ago.

That sounds quite silly in a manual, doesn't it?
There is no need to document every single ancient groff
idiosyncrasy, that would just bloat the documentation.

Of course it's always a matter of judgement, i think clear
rules are hard to find for deciding what warrants mention
below COMPATIBILITY.  Roughly, i'd say that

 * Recent changes are more important than ancient bugs.
 * Groff/mandoc differences are more important than
   new/old groff differences.
 * Parser incompatibilities are more important than rendering
   differences.
 * Text differences are more important than whitespace
   differences.

Very roughly, i'd maybe say that we should mention it
if it's recent OR affects the parsers OR may affect the
content.

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