Skip site navigation (1)Skip section navigation (2)
Date:      Wed, 10 Aug 2022 12:27:48 GMT
From:      Gordon Bergling <gbe@FreeBSD.org>
To:        src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-branches@FreeBSD.org
Subject:   git: 6d8e1fd525dc - stable/12 - libutil: Fix mandoc warnings
Message-ID:  <202208101227.27ACRmX8073251@gitrepo.freebsd.org>

next in thread | raw e-mail | index | archive | help
The branch stable/12 has been updated by gbe (doc committer):

URL: https://cgit.FreeBSD.org/src/commit/?id=6d8e1fd525dc8ace3d2435e21ae7dd04eae0c993

commit 6d8e1fd525dc8ace3d2435e21ae7dd04eae0c993
Author:     Gordon Bergling <gbe@FreeBSD.org>
AuthorDate: 2022-08-07 14:30:24 +0000
Commit:     Gordon Bergling <gbe@FreeBSD.org>
CommitDate: 2022-08-10 12:27:39 +0000

    libutil: Fix mandoc warnings
    
    - missing comma before name
    - possible typo in section name: Sh CAVEAT instead of CAVEATS
    - useless macro: Tn
    - blank line in fill mode, using .sp
    - no blank before trailing delimiter: Dv NULL?
    
    (cherry picked from commit 816ca3d10fd2f0c9283005a189fac156071d748d)
---
 lib/libutil/humanize_number.3 |  8 ++------
 lib/libutil/kinfo_getvmmap.3  | 14 +++++++-------
 lib/libutil/login_tty.3       |  1 -
 lib/libutil/pty.3             |  2 +-
 lib/libutil/pw_util.3         |  2 +-
 lib/libutil/quotafile.3       | 22 +++++++++++-----------
 6 files changed, 22 insertions(+), 27 deletions(-)

diff --git a/lib/libutil/humanize_number.3 b/lib/libutil/humanize_number.3
index 9259f377abf2..2617317d6e18 100644
--- a/lib/libutil/humanize_number.3
+++ b/lib/libutil/humanize_number.3
@@ -183,12 +183,8 @@ The
 and
 .Dv HN_IEC_PREFIXES
 flags
-conform to
-.Tn ISO/IEC
-Std\~80000-13:2008
-and
-.Tn IEEE
-Std\~1541-2002.
+conform to ISO/IEC Std\~80000-13:2008
+and IEEE Std\~1541-2002.
 .Sh HISTORY
 The
 .Fn humanize_number
diff --git a/lib/libutil/kinfo_getvmmap.3 b/lib/libutil/kinfo_getvmmap.3
index c36f5fc5b6b5..cd996128d9e0 100644
--- a/lib/libutil/kinfo_getvmmap.3
+++ b/lib/libutil/kinfo_getvmmap.3
@@ -58,13 +58,6 @@ with the
 mib.
 While the kernel returns a packed structure, this function expands the
 data into a fixed record format.
-.Sh CAVEAT
-.Fn kinfo_getvmmap
-calls can cause significant CPU consumption because calculating the residency
-counts requires iterating over all memory pages of the process.
-Setting the sysctl variable
-.Va kern.proc_vmmap_skip_resident_count
-to 1 prevents this calculation.
 .Sh RETURN VALUES
 On success the
 .Fn kinfo_getvmmap
@@ -89,3 +82,10 @@ The
 .Fn kinfo_getvmmap
 function first appeared in
 .Fx 7.0 .
+.Sh CAVEATS
+.Fn kinfo_getvmmap
+calls can cause significant CPU consumption because calculating the residency
+counts requires iterating over all memory pages of the process.
+Setting the sysctl variable
+.Va kern.proc_vmmap_skip_resident_count
+to 1 prevents this calculation.
diff --git a/lib/libutil/login_tty.3 b/lib/libutil/login_tty.3
index 89636d86686d..97327db13714 100644
--- a/lib/libutil/login_tty.3
+++ b/lib/libutil/login_tty.3
@@ -68,4 +68,3 @@ The function
 .Fn login_tty
 first appeared in
 .Bx 4.4 .
-
diff --git a/lib/libutil/pty.3 b/lib/libutil/pty.3
index c676447d20e4..86280299a43f 100644
--- a/lib/libutil/pty.3
+++ b/lib/libutil/pty.3
@@ -149,7 +149,7 @@ The
 and
 .Fn forkpty
 functions first appeared in
-.Bx 4.3 Reno.
+.Bx 4.3 Reno .
 .Sh BUGS
 .Fn openpty
 writes the slave terminal's name to
diff --git a/lib/libutil/pw_util.3 b/lib/libutil/pw_util.3
index 8855eba8d925..d91e19373515 100644
--- a/lib/libutil/pw_util.3
+++ b/lib/libutil/pw_util.3
@@ -191,7 +191,7 @@ it will default to
 .Fa master
 is the name of the password file.
 If set to
-.Dv NULL?
+.Dv NULL ?
 it will default to
 .Pa master.passwd
 .Pp
diff --git a/lib/libutil/quotafile.3 b/lib/libutil/quotafile.3
index 362cf018554a..153fc106c589 100644
--- a/lib/libutil/quotafile.3
+++ b/lib/libutil/quotafile.3
@@ -29,17 +29,17 @@
 .Dt QUOTAFILE 3
 .Os
 .Sh NAME
-.Nm quota_open
-.Nm quota_close
-.Nm quota_on
-.Nm quota_off
-.Nm quota_read
-.Nm quota_write_limits
-.Nm quota_write_usage
-.Nm quota_fsname
-.Nm quota_qfname
-.Nm quota_maxid
-.Nm quota_check_path
+.Nm quota_open ,
+.Nm quota_close ,
+.Nm quota_on ,
+.Nm quota_off ,
+.Nm quota_read ,
+.Nm quota_write_limits ,
+.Nm quota_write_usage ,
+.Nm quota_fsname ,
+.Nm quota_qfname ,
+.Nm quota_maxid ,
+.Nm quota_check_path ,
 .Nm quota_convert
 .Nd "Manipulate quotas"
 .Sh LIBRARY



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