Skip to content

Commit b602456

Browse files
gpercivabsdjhb
authored andcommitted
manuals: Misc macro typos
These were reported by `mandoc -T lint` as ERROR: skipping unknown macro When these pages were rendered with `man`, the "unknown macro" meant that the entire line was omitted from the output. Obvious typos in: lib/libsys/swapon.2 lib/libsys/procctl.2 share/man/man9/firmware.9 lib/libcasper/services/cap_net/cap_net.3: 'mode' describes a function argument. lib/libsys/statfs.2: there's no .Tm command ("trademark?"), and .Tn ("tradename") is deprecated, so remove the macro entirely. usr.sbin/mfiutil/mfiutil.8: man was interpreting '/dev/' as a macro (which it didn't recognize). share/man/man4/qat.4: same issue as above, but with '0'. In this case, given the context of the previous line, rewriting as "Value '0'" seemed more appropriate. usr.sbin/mlx5tool/mlx5tool.8: typo in .Xr Signed-off-by: Graham Percival <gperciva@tarsnap.com> Sponsored by: Tarsnap Backup Inc. Reviewed by: concussious, imp Pull Request: freebsd/freebsd-src#1417
2 parents d26a530 + 2878d99 commit b602456

File tree

8 files changed

+9
-10
lines changed

8 files changed

+9
-10
lines changed

lib/libcasper/services/cap_net/cap_net.3

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ The
121121
.Fn cap_net_limit_init
122122
returns an opaque limit handle used to store a list of capabilities.
123123
The
124-
.Fv mode
124+
.Fa mode
125125
restricts the functionality of the service.
126126
Modes are encoded using the following flags:
127127
.Pp

lib/libsys/procctl.2

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ All status changing requests
7575
.Dv *_CTL
7676
require the caller to have the right to debug the target.
7777
All status query requests
78-
.DV *_STATUS
78+
.Dv *_STATUS
7979
require the caller to have the right to observe the target.
8080
.Pp
8181
The following commands are supported:

lib/libsys/statfs.2

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -231,9 +231,7 @@ Corrupted data was detected while reading from the file system.
231231
The fields in the
232232
.Vt statfs
233233
structure have been defined to provide the parameters relevant for
234-
traditional
235-
.Tm UNIX
236-
file systems.
234+
traditional UNIX file systems.
237235
For some other file systems, values that have similar, but not
238236
identical, semantics to those described above may be returned.
239237
An example is msdosfs, which in case of FAT12 or FAT16 file systems

lib/libsys/swapon.2

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ is made available for other purposes.
6767
The
6868
.Fa special
6969
argument points to the name of the device or file used for swapping.
70-
.The
70+
The
7171
.Va flags
7272
argument takes the following flags:
7373
.Bl -tag -width SWAPOFF_FORCE

share/man/man4/qat.4

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ QAT firmware revision number.
148148
Summary of device specific configuration.
149149
.It Va heartbeat
150150
QAT device heartbeat status. Value '1' indicates that the device is operational.
151-
'0' value means that the device is not responsive. Device requires restart.
151+
Value '0' means that the device is not responsive. Device requires restart.
152152
.It Va heartbeat_failed
153153
Number of QAT heartbeat failures received.
154154
.It Va heartbeat_sent

share/man/man9/firmware.9

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -341,7 +341,7 @@ uses the following algorithm to find firmware images:
341341
.It
342342
If an existing firmware image is registered for
343343
.Fa imagename,
344-
.that image is returned.
344+
that image is returned.
345345
.It
346346
If
347347
.Fa imagename

usr.sbin/mfiutil/mfiutil.8

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -271,7 +271,8 @@ Currently three global options are supported:
271271
.It Fl D Ar device
272272
.Ar device
273273
specifies the device node of the controller to use.
274-
'/dev/' will be added to the device node if needed.
274+
.Pa /dev/
275+
will be added to the device node if needed.
275276
If no device node is specified,
276277
then device will be made of the type and device.
277278
.It Fl t Ar type

usr.sbin/mlx5tool/mlx5tool.8

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ The utility executes commands on specific adapter, which is addressed using
6060
.Em device:bus:slot:function
6161
conventions of the PCIe buses.
6262
You can match adapters ethernet name and addresses using the
63-
.X pciconf 8
63+
.Xr pciconf 8
6464
utility.
6565
The address is passed as an argument of the
6666
.Fl d

0 commit comments

Comments
 (0)