Re: vscsi.4, wsdisplay.4: add missing Dv tags to ioctl constants

2017-09-12 Thread Ingo Schwarze
Hi Scott,

Scott Cheloha wrote on Mon, Sep 11, 2017 at 11:57:13PM -0500:

> Constants without the Dv styling stick out quite a bit in a browser.
> This patch adds them to the ioctl constants in vscsi.4 and the two
> lone constants without them in wsdisplay.4.
> 
> I also noticed that wsdisplay.4 is perhaps the only device driver
> page not using Fa for its ioctl arguments,

Not the only one, but one among very few.  I just fixed all the
outliers.

> so it might make sense to
> sneak in the missing Dvs as part of a patch that makes the switch
> from Pq+Li to Fa (attached below with the vscsi.4 changes).

All committed.

Thanks,
  Ingo



vscsi.4, wsdisplay.4: add missing Dv tags to ioctl constants

2017-09-11 Thread Scott Cheloha
Hi,

Constants without the Dv styling stick out quite a bit in a browser.
This patch adds them to the ioctl constants in vscsi.4 and the two
lone constants without them in wsdisplay.4.

I also noticed that wsdisplay.4 is perhaps the only device driver
page not using Fa for its ioctl arguments, so it might make sense to
sneak in the missing Dvs as part of a patch that makes the switch
from Pq+Li to Fa (attached below with the vscsi.4 changes).

... but if that isn't the case, the following only adds the Dvs:

Index: share/man/man4/wsdisplay.4
===
RCS file: /cvs/src/share/man/man4/wsdisplay.4,v
retrieving revision 1.51
diff -u -p -r1.51 wsdisplay.4
--- share/man/man4/wsdisplay.4  1 Sep 2016 12:24:56 -   1.51
+++ share/man/man4/wsdisplay.4  12 Sep 2017 04:35:20 -
@@ -487,8 +487,8 @@ The
 field is set to the font resource to query.
 For the argument structure, see
 .Dv WSDISPLAYIO_LDFONT .
-.\" WSDISPLAYIO_DELFONT Pq Li struct wsdisplay_font
-.It WSDISPLAYIO_USEFONT Pq Li struct wsdisplay_font
+.\" Dv WSDISPLAYIO_DELFONT Pq Li struct wsdisplay_font
+.It Dv WSDISPLAYIO_USEFONT Pq Li struct wsdisplay_font
 Selects the font specified in the
 .Va name
 field.

--
Scott Cheloha

Index: share/man/man4/vscsi.4
===
RCS file: /cvs/src/share/man/man4/vscsi.4,v
retrieving revision 1.13
diff -u -p -r1.13 vscsi.4
--- share/man/man4/vscsi.4  28 Jun 2014 06:42:42 -  1.13
+++ share/man/man4/vscsi.4  12 Sep 2017 04:02:12 -
@@ -41,7 +41,7 @@ commands are provided to allow userland 
 them:
 .Pp
 .Bl -tag -width Ds -compact
-.It VSCSI_I2T Fa "struct vscsi_ioc_i2t *"
+.It Dv VSCSI_I2T Fa "struct vscsi_ioc_i2t *"
 Dequeue a SCSI command.
 If no SCSI commands are available to dequeue,
 .Xr ioctl 2
@@ -71,8 +71,8 @@ struct vscsi_ioc_i2t {
 };
 .Ed
 .Pp
-.It VSCSI_DATA_READ Fa "struct vscsi_ioc_data *"
-.It VSCSI_DATA_WRITE Fa "struct vscsi_ioc_data *"
+.It Dv VSCSI_DATA_READ Fa "struct vscsi_ioc_data *"
+.It Dv VSCSI_DATA_WRITE Fa "struct vscsi_ioc_data *"
 Read or write data in response to a SCSI command identified by tag.
 .Bd -literal -offset indent
 struct vscsi_ioc_data {
@@ -83,7 +83,7 @@ struct vscsi_ioc_data {
 };
 .Ed
 .Pp
-.It VSCSI_T2I Fa "struct vscsi_ioc_t2i *"
+.It Dv VSCSI_T2I Fa "struct vscsi_ioc_t2i *"
 Signal completion of a SCSI command identified by tag.
 .Bd -literal -offset indent
 struct vscsi_ioc_t2i {
@@ -98,8 +98,8 @@ struct vscsi_ioc_t2i {
 };
 .Ed
 .Pp
-.It VSCSI_REQPROBE Fa "struct vscsi_ioc_devevent *"
-.It VSCSI_REQDETACH Fa "struct vscsi_ioc_devevent *"
+.It Dv VSCSI_REQPROBE Fa "struct vscsi_ioc_devevent *"
+.It Dv VSCSI_REQDETACH Fa "struct vscsi_ioc_devevent *"
 Request a probe or a detach of the device at the addresses specified by the
 target and lun fields.
 .Bd -literal -offset indent
Index: share/man/man4/wsdisplay.4
===
RCS file: /cvs/src/share/man/man4/wsdisplay.4,v
retrieving revision 1.51
diff -u -p -r1.51 wsdisplay.4
--- share/man/man4/wsdisplay.4  1 Sep 2016 12:24:56 -   1.51
+++ share/man/man4/wsdisplay.4  12 Sep 2017 04:02:12 -
@@ -144,11 +144,11 @@ driver or by devices which use it.
 Their definitions are found in
 .In dev/wscons/wsconsio.h .
 .Bl -tag -width 4n
-.It Dv WSDISPLAYIO_GTYPE Pq Li u_int
+.It Dv WSDISPLAYIO_GTYPE Fa u_int
 Retrieve the type of the display.
 The list of types is in
 .In dev/wscons/wsconsio.h .
-.It Dv WSDISPLAYIO_GINFO Pq Li "struct wsdisplay_fbinfo"
+.It Dv WSDISPLAYIO_GINFO Fa "struct wsdisplay_fbinfo"
 Retrieve basic information about a framebuffer display.
 The returned structure is as follows:
 .Bd -literal -offset indent
@@ -174,7 +174,7 @@ indicates the number of color map entrie
 and
 .Dv WSDISPLAYIO_PUTCMAP .
 This call is likely to be unavailable on text-only displays.
-.It Dv WSDISPLAYIO_GETCMAP Pq Li "struct wsdisplay_cmap"
+.It Dv WSDISPLAYIO_GETCMAP Fa "struct wsdisplay_cmap"
 Retrieve the current color map from the display.
 This call needs the
 following structure set up beforehand:
@@ -206,7 +206,7 @@ color map.
 On all displays that support this call, values range from 0 for minimum
 intensity to 255 for maximum intensity, even if the display does not use
 eight bits internally to represent intensity.
-.It Dv WSDISPLAYIO_PUTCMAP Pq Li "struct wsdisplay_cmap"
+.It Dv WSDISPLAYIO_PUTCMAP Fa "struct wsdisplay_cmap"
 Change the display's color map.
 The argument structure is the same as for
 .Dv WSDISPLAYIO_GETCMAP ,
@@ -217,7 +217,7 @@ and
 .Va blue
 are taken as pointers to the values to use to set the color map.
 This call is not available on displays with fixed color maps.
-.It Dv WSDISPLAYIO_GVIDEO Pq Li u_int
+.It Dv WSDISPLAYIO_GVIDEO Fa u_int
 Get the current state of the display's video output.
 Possible values are:
 .Bl -tag -width 21n
@@ -226,12 +226,12 @@ The display is blanked.
 .It Dv WSDISPLAYIO_VI