git: 3251ad29f429 - main - libcasper(3): Correct some warnings found by mandoc

Gordon Bergling gbe at FreeBSD.org
Mon Jul 12 04:18:53 UTC 2021


The branch main has been updated by gbe (doc committer):

URL: https://cgit.FreeBSD.org/src/commit/?id=3251ad29f4295ad73668a46727c5bbf7bbac0cf7

commit 3251ad29f4295ad73668a46727c5bbf7bbac0cf7
Author:     Gordon Bergling <gbe at FreeBSD.org>
AuthorDate: 2021-07-12 04:16:55 +0000
Commit:     Gordon Bergling <gbe at FreeBSD.org>
CommitDate: 2021-07-12 04:16:55 +0000

    libcasper(3): Correct some warnings found by mandoc
    
    - inserting missing end of block: Sh breaks Bl
    - moving content out of list: Pp
    - missing comma before name: Nm cap_*
    - comma in function argument: cap_*
    - skipping paragraph macro: Pp after Sh
    - sections out of conventional order: Sh AUTHORS
    
    Reviewed by:    bcr
    MFC after:      1 week
    Differential Revision:  https://reviews.freebsd.org/D31144
---
 lib/libcasper/libcasper/libcasper.3                |  3 ++-
 lib/libcasper/services/cap_dns/cap_dns.3           |  1 +
 lib/libcasper/services/cap_fileargs/cap_fileargs.3 |  5 +++--
 lib/libcasper/services/cap_net/cap_net.3           |  5 ++---
 lib/libcasper/services/cap_syslog/cap_syslog.3     | 10 +++++-----
 5 files changed, 13 insertions(+), 11 deletions(-)

diff --git a/lib/libcasper/libcasper/libcasper.3 b/lib/libcasper/libcasper/libcasper.3
index 149dd49eb1c9..bf678457abeb 100644
--- a/lib/libcasper/libcasper/libcasper.3
+++ b/lib/libcasper/libcasper/libcasper.3
@@ -200,8 +200,8 @@ obtained via the
 function.
 The function returns capability that provides access to opened service.
 Casper supports the following services in the base system:
-.Bl -tag -width "system.random" -compact -offset indent
 .Pp
+.Bl -tag -width "system.random" -compact -offset indent
 .It system.dns
 provides DNS libc compatible API
 .It system.grp
@@ -222,6 +222,7 @@ compatible API
 provides
 .Xr syslog 3
 compatible API
+.El
 .Sh RETURN VALUES
 The
 .Fn cap_clone ,
diff --git a/lib/libcasper/services/cap_dns/cap_dns.3 b/lib/libcasper/services/cap_dns/cap_dns.3
index 104e37f53d86..faa994dc2a6f 100644
--- a/lib/libcasper/services/cap_dns/cap_dns.3
+++ b/lib/libcasper/services/cap_dns/cap_dns.3
@@ -158,6 +158,7 @@ The
 limits service to one of the address families (e.g.
 .Dv AF_INET , AF_INET6 ,
 etc.).
+.El
 .Sh EXAMPLES
 The following example first opens a capability to casper and then uses this
 capability to create the
diff --git a/lib/libcasper/services/cap_fileargs/cap_fileargs.3 b/lib/libcasper/services/cap_fileargs/cap_fileargs.3
index acf51e4ed62b..a02f58d4b4fa 100644
--- a/lib/libcasper/services/cap_fileargs/cap_fileargs.3
+++ b/lib/libcasper/services/cap_fileargs/cap_fileargs.3
@@ -222,6 +222,7 @@ argument contains a list of the capability rights which file should be limited t
 Any number of
 .Dv NV_TYPE_NULL
 where the name of the element is name of the file which can be opened.
+.El
 .Sh EXAMPLES
 The following example first parse some options and then create the
 .Nm system.fileargs
@@ -279,6 +280,8 @@ The
 .Nm cap_fileargs
 service first appeared in
 .Fx 10.3 .
+.Sh AUTHORS
+.An Mariusz Zaborski Aq Mt oshogbo at FreeBSD.org
 .Sh BUGS
 The
 .Lb cap_fileargs
@@ -287,5 +290,3 @@ included in
 is considered experimental, and should not be deployed in production
 environments without careful consideration of the risks associated with
 the use of experimental operating system features.
-.Sh AUTHORS
-.An Mariusz Zaborski Aq Mt oshogbo at FreeBSD.org
diff --git a/lib/libcasper/services/cap_net/cap_net.3 b/lib/libcasper/services/cap_net/cap_net.3
index cd0b4450fdaf..e74f7dd70d67 100644
--- a/lib/libcasper/services/cap_net/cap_net.3
+++ b/lib/libcasper/services/cap_net/cap_net.3
@@ -83,10 +83,9 @@
 .Ft "cap_net_limit_t *"
 .Fn cap_net_limit_bind "cap_net_limit_t *limit" "const struct sockaddr *sa" "socklen_t salen"
 .Sh DESCRIPTION
-.Pp
 The functions
-.Fn cap_bind,
-.Fn cap_connect,
+.Fn cap_bind ,
+.Fn cap_connect ,
 .Fn cap_gethostbyname ,
 .Fn cap_gethostbyname2 ,
 .Fn cap_gethostbyaddr
diff --git a/lib/libcasper/services/cap_syslog/cap_syslog.3 b/lib/libcasper/services/cap_syslog/cap_syslog.3
index 33ca6527204e..71c3e790fd97 100644
--- a/lib/libcasper/services/cap_syslog/cap_syslog.3
+++ b/lib/libcasper/services/cap_syslog/cap_syslog.3
@@ -28,10 +28,10 @@
 .Dt CAP_SYSLOG 3
 .Os
 .Sh NAME
-.Nm cap_syslog
-.Nm cap_vsyslog
-.Nm cap_openlog
-.Nm cap_closelog
+.Nm cap_syslog ,
+.Nm cap_vsyslog ,
+.Nm cap_openlog ,
+.Nm cap_closelog ,
 .Nm cap_setlogmask
 .Nd "library for syslog in capability mode"
 .Sh LIBRARY
@@ -98,7 +98,7 @@ cap_syslog(capsyslog, LOG_NOTICE, "System logs from capability mode.");
 .Xr closelog 3 ,
 .Xr err 3 ,
 .Xr openlog 3 ,
-.Xr setlogmask 3
+.Xr setlogmask 3 ,
 .Xr syslog 3 ,
 .Xr vsyslog 3 ,
 .Xr capsicum 4 ,


More information about the dev-commits-src-main mailing list