git: 2878d99dfcfb - main - manuals: Misc macro typos
- Go to: [ bottom of page ] [ top of archives ] [ this month ]
Date: Sat, 21 Sep 2024 11:26:19 UTC
The branch main has been updated by imp: URL: https://cgit.FreeBSD.org/src/commit/?id=2878d99dfcfbdd7a415a7f31cf95fbd53fc8e581 commit 2878d99dfcfbdd7a415a7f31cf95fbd53fc8e581 Author: Graham Percival <gperciva@tarsnap.com> AuthorDate: 2024-09-12 16:36:42 +0000 Commit: Warner Losh <imp@FreeBSD.org> CommitDate: 2024-09-21 11:25:15 +0000 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: https://github.com/freebsd/freebsd-src/pull/1417 --- lib/libcasper/services/cap_net/cap_net.3 | 2 +- lib/libsys/procctl.2 | 2 +- lib/libsys/statfs.2 | 4 +--- lib/libsys/swapon.2 | 2 +- share/man/man4/qat.4 | 2 +- share/man/man9/firmware.9 | 2 +- usr.sbin/mfiutil/mfiutil.8 | 3 ++- usr.sbin/mlx5tool/mlx5tool.8 | 2 +- 8 files changed, 9 insertions(+), 10 deletions(-) diff --git a/lib/libcasper/services/cap_net/cap_net.3 b/lib/libcasper/services/cap_net/cap_net.3 index 6e525508d3c4..e322222e866f 100644 --- a/lib/libcasper/services/cap_net/cap_net.3 +++ b/lib/libcasper/services/cap_net/cap_net.3 @@ -121,7 +121,7 @@ The .Fn cap_net_limit_init returns an opaque limit handle used to store a list of capabilities. The -.Fv mode +.Fa mode restricts the functionality of the service. Modes are encoded using the following flags: .Pp diff --git a/lib/libsys/procctl.2 b/lib/libsys/procctl.2 index cdb379696401..df8119799c6d 100644 --- a/lib/libsys/procctl.2 +++ b/lib/libsys/procctl.2 @@ -75,7 +75,7 @@ All status changing requests .Dv *_CTL require the caller to have the right to debug the target. All status query requests -.DV *_STATUS +.Dv *_STATUS require the caller to have the right to observe the target. .Pp The following commands are supported: diff --git a/lib/libsys/statfs.2 b/lib/libsys/statfs.2 index 50809869a022..a2abd9e7d7cd 100644 --- a/lib/libsys/statfs.2 +++ b/lib/libsys/statfs.2 @@ -231,9 +231,7 @@ Corrupted data was detected while reading from the file system. The fields in the .Vt statfs structure have been defined to provide the parameters relevant for -traditional -.Tm UNIX -file systems. +traditional UNIX file systems. For some other file systems, values that have similar, but not identical, semantics to those described above may be returned. An example is msdosfs, which in case of FAT12 or FAT16 file systems diff --git a/lib/libsys/swapon.2 b/lib/libsys/swapon.2 index d7694ed48c8e..23ed0bc2aa83 100644 --- a/lib/libsys/swapon.2 +++ b/lib/libsys/swapon.2 @@ -67,7 +67,7 @@ is made available for other purposes. The .Fa special argument points to the name of the device or file used for swapping. -.The +The .Va flags argument takes the following flags: .Bl -tag -width SWAPOFF_FORCE diff --git a/share/man/man4/qat.4 b/share/man/man4/qat.4 index b0fa0b0cbc92..02be0837ce54 100644 --- a/share/man/man4/qat.4 +++ b/share/man/man4/qat.4 @@ -148,7 +148,7 @@ QAT firmware revision number. Summary of device specific configuration. .It Va heartbeat QAT device heartbeat status. Value '1' indicates that the device is operational. -'0' value means that the device is not responsive. Device requires restart. +Value '0' means that the device is not responsive. Device requires restart. .It Va heartbeat_failed Number of QAT heartbeat failures received. .It Va heartbeat_sent diff --git a/share/man/man9/firmware.9 b/share/man/man9/firmware.9 index 883f0a2634d4..f324861248d2 100644 --- a/share/man/man9/firmware.9 +++ b/share/man/man9/firmware.9 @@ -341,7 +341,7 @@ uses the following algorithm to find firmware images: .It If an existing firmware image is registered for .Fa imagename, -.that image is returned. +that image is returned. .It If .Fa imagename diff --git a/usr.sbin/mfiutil/mfiutil.8 b/usr.sbin/mfiutil/mfiutil.8 index 86dc6b6ee122..9f8cacf7f16d 100644 --- a/usr.sbin/mfiutil/mfiutil.8 +++ b/usr.sbin/mfiutil/mfiutil.8 @@ -271,7 +271,8 @@ Currently three global options are supported: .It Fl D Ar device .Ar device specifies the device node of the controller to use. -'/dev/' will be added to the device node if needed. +.Pa /dev/ +will be added to the device node if needed. If no device node is specified, then device will be made of the type and device. .It Fl t Ar type diff --git a/usr.sbin/mlx5tool/mlx5tool.8 b/usr.sbin/mlx5tool/mlx5tool.8 index 13c19d2d032b..cca1adeedbeb 100644 --- a/usr.sbin/mlx5tool/mlx5tool.8 +++ b/usr.sbin/mlx5tool/mlx5tool.8 @@ -60,7 +60,7 @@ The utility executes commands on specific adapter, which is addressed using .Em device:bus:slot:function conventions of the PCIe buses. You can match adapters ethernet name and addresses using the -.X pciconf 8 +.Xr pciconf 8 utility. The address is passed as an argument of the .Fl d