git: ce95864fbad8 - main - rc.conf(5): Style issues

From: Warner Losh <imp_at_FreeBSD.org>
Date: Tue, 28 Feb 2023 16:39:56 UTC
The branch main has been updated by imp:

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

commit ce95864fbad87b53f17c625d3b72318764446f00
Author:     Warner Losh <imp@FreeBSD.org>
AuthorDate: 2023-02-28 16:28:30 +0000
Commit:     Warner Losh <imp@FreeBSD.org>
CommitDate: 2023-02-28 16:36:28 +0000

    rc.conf(5): Style issues
    
    Fix mandoc -Tlint style issues
    * Use Pa instead of Va for .conf element (mdoc warned the Va was unused, and its the
      wrong markup anyway)
    * Drop useless Va and use Va instead of Ar when referring to variables in the jail file
    * One sentence, one line
    * drop xr to info(1). That makes no sense, and intro(1) seems unhelpful.
    
    This leaves two warnings: gdb(1) xref not found (but we add a
    parenthetical about the package) and a false positive about
    a trailing period that is being mistaken for a 'full stop'
    when it is really just a character in a filename.
    
    Sponsored by:           Netflix
---
 share/man/man5/rc.conf.5 | 16 +++++++++-------
 1 file changed, 9 insertions(+), 7 deletions(-)

diff --git a/share/man/man5/rc.conf.5 b/share/man/man5/rc.conf.5
index db1dfd3b6b81..7d1cdfc61966 100644
--- a/share/man/man5/rc.conf.5
+++ b/share/man/man5/rc.conf.5
@@ -482,7 +482,8 @@ In some cases it may be undesirable to save
 at shutdown.
 When set to "NO"
 .Pa /var/run
-is loaded at reboot but not saved at shutdown. Typically in this scenario
+is loaded at reboot but not saved at shutdown.
+Typically in this scenario
 a
 .Pa service
 .Pa var_run
@@ -494,7 +495,8 @@ directory structure once, to be reload during all subsequent reboots.
 .Pq Vt str
 Where to save the
 .Pa /var/run
-mtree. The default location is
+mtree.
+The default location is
 .Pa /var/db/mtree/BSD.var-run.mtree .
 .It Va local_startup
 .Pq Vt str
@@ -768,7 +770,8 @@ Destination server port for receiving netflow data
 .Pa 9995 ) .
 .It Va ipfw_netflow_version
 .Pq Vt int
-Do not set for using version 5 of the netflow protocol, set it to 9 for using version 9.
+Do not set for using version 5 of the netflow protocol, set it to 9 for using
+version 9.
 .It Va ipfw_netflow_fib
 .Pq Vt int
 Only match packet in FIB
@@ -3959,11 +3962,11 @@ The configuration filename used by
 utility.
 The default value is
 .Pa /etc/jail.conf .
-.Pa /etc/jail.  Ns Ao Ar jname Ac Ns Va .conf
+.Pa /etc/jail. Ns Ao Va jname Ac Ns Pa .conf
 and
-.Pa /etc/jail.conf.d/ Ns Ao Ar jname Ac Ns Va .conf
+.Pa /etc/jail.conf.d/ Ns Ao Va jname Ac Ns Pa .conf
 will also be used if
-.Va Ao Ar jname Ac Va
+.Ao Va jname Ac
 is set in
 .Va jail_list .
 .It Va jail_parallel_start
@@ -4898,7 +4901,6 @@ these are the flags to pass to the
 .Sh SEE ALSO
 .Xr chmod 1 ,
 .Xr gdb 1 Pq Pa ports/devel/gdb ,
-.Xr info 1 ,
 .Xr kbdcontrol 1 ,
 .Xr limits 1 ,
 .Xr protect 1 ,