Skip site navigation (1)Skip section navigation (2)
Date:      Fri, 27 Dec 2024 17:06:48 GMT
From:      John Baldwin <jhb@FreeBSD.org>
To:        src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-branches@FreeBSD.org
Subject:   git: 0d17ac9c2202 - stable/13 - manuals: Misc macro typos
Message-ID:  <202412271706.4BRH6mlP038231@gitrepo.freebsd.org>

next in thread | raw e-mail | index | archive | help
The branch stable/13 has been updated by jhb:

URL: https://cgit.FreeBSD.org/src/commit/?id=0d17ac9c22028eee7121b25a7039ecec7dbc47f0

commit 0d17ac9c22028eee7121b25a7039ecec7dbc47f0
Author:     Graham Percival <gperciva@tarsnap.com>
AuthorDate: 2024-09-12 16:36:42 +0000
Commit:     John Baldwin <jhb@FreeBSD.org>
CommitDate: 2024-12-27 15:47:13 +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
    
    (cherry picked from commit 2878d99dfcfbdd7a415a7f31cf95fbd53fc8e581)
---
 lib/libc/sys/procctl.2                   | 2 +-
 lib/libc/sys/statfs.2                    | 4 +---
 lib/libc/sys/swapon.2                    | 2 +-
 lib/libcasper/services/cap_net/cap_net.3 | 2 +-
 usr.sbin/mlx5tool/mlx5tool.8             | 2 +-
 5 files changed, 5 insertions(+), 7 deletions(-)

diff --git a/lib/libc/sys/procctl.2 b/lib/libc/sys/procctl.2
index 0f63c37cba58..497e9bfaeded 100644
--- a/lib/libc/sys/procctl.2
+++ b/lib/libc/sys/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/libc/sys/statfs.2 b/lib/libc/sys/statfs.2
index b09c91fea3fb..9dc43c1daa19 100644
--- a/lib/libc/sys/statfs.2
+++ b/lib/libc/sys/statfs.2
@@ -233,9 +233,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 FAT13 file systems
diff --git a/lib/libc/sys/swapon.2 b/lib/libc/sys/swapon.2
index 8cfac8ce1f64..b5adda8df2fd 100644
--- a/lib/libc/sys/swapon.2
+++ b/lib/libc/sys/swapon.2
@@ -69,7 +69,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/lib/libcasper/services/cap_net/cap_net.3 b/lib/libcasper/services/cap_net/cap_net.3
index 2851c2f023a0..3987056e2643 100644
--- a/lib/libcasper/services/cap_net/cap_net.3
+++ b/lib/libcasper/services/cap_net/cap_net.3
@@ -110,7 +110,7 @@ interface can be used to restrict access to the network.
 .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/usr.sbin/mlx5tool/mlx5tool.8 b/usr.sbin/mlx5tool/mlx5tool.8
index 17f0fd515a50..5f4157c4d49c 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



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?202412271706.4BRH6mlP038231>