git: 0584ccf61a23 - stable/12 - MFC r368813: bluetooth: Fix a mandoc related issues

Sun Dec 27 13:03:41 UTC 2020

The branch stable/12 has been updated by gbe (doc committer):

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

commit 0584ccf61a2330532e96b59c3adefb984670e921
Author:     Gordon Bergling <gbe at FreeBSD.org>
AuthorDate: 2020-12-19 13:36:59 +0000
Commit:     Gordon Bergling <gbe at FreeBSD.org>
CommitDate: 2020-12-27 12:54:32 +0000

    MFC r368813:  bluetooth: Fix a mandoc related issues
    
    - new sentence, new line
    - sections out of conventional order: Sh FILES
    - unusual Xr order: bthost(1) after bthidd(8)
    - no blank before trailing delimiter
    - whitespace at end of input line
    - sections out of conventional order: Sh EXIT STATUS
    
    (cherry picked from commit 60ee05db4b19763137c399a0d79509af14e7440a)
---
 .../bluetooth/bluetooth-config/bluetooth-config.8    | 18 ++++++++++--------
 usr.sbin/bluetooth/hccontrol/hccontrol.8             |  9 ++++-----
 usr.sbin/bluetooth/hcseriald/hcseriald.8             |  2 +-
 usr.sbin/bluetooth/sdpd/sdpd.8                       | 20 ++++++++++----------
 4 files changed, 25 insertions(+), 24 deletions(-)

diff --git a/usr.sbin/bluetooth/bluetooth-config/bluetooth-config.8 b/usr.sbin/bluetooth/bluetooth-config/bluetooth-config.8
index 525c0c5749b4..fe5785265ce8 100644
--- a/usr.sbin/bluetooth/bluetooth-config/bluetooth-config.8
+++ b/usr.sbin/bluetooth/bluetooth-config/bluetooth-config.8
@@ -45,7 +45,8 @@ The following options are available:
 .It Fl d
 Scan for a specific bluetooth device address.
 .It Fl n
-Limit scan to a specific host controller. Hint: List all netgraph nodes with
+Limit scan to a specific host controller.
+Hint: List all netgraph nodes with
 .Ql /usr/sbin/ngctl list .
 .El
 .Pp
@@ -62,11 +63,6 @@ keyboards, configure and restart
 .Nm
 can bring up any interface and daemon necessary for operation and, if a node is provided on
 command line, will do so automatically for that interface.
-.Sh CAVEATS
-.Nm
-can not parse entries in
-.Xr hcsecd 8
-config file and thus will ask the user to manually modify existing pairing PIN entries.
 .Sh FILES
 .Bl -tag -width ".Pa /etc/bluetooth/hosts" -compact
 .It Pa /etc/bluetooth/hosts
@@ -79,7 +75,8 @@ scan -n ubt0 -a 00:26:bb:7a:58:95
 .Bd -ragged -offset indent
 This will scan the bluetooth controller ubt0hci for a bluetooth device with the address
 00:26:bb:7a:58:95, set up ubt0 if necessary and enter an interactive dialog to pair the
-new device. Since in this example a mouse is paired,
+new device.
+Since in this example a mouse is paired,
 .Nm
 will interact with
 .Xr bthidd 8 ,
@@ -93,9 +90,9 @@ This will scan all bluetooth controllers on the systems for bluetooth devices, p
 to bring up controllers or daemons along the way.
 .Ed
 .Sh SEE ALSO
+.Xr bthost 1 ,
 .Xr bthidcontrol 8 ,
 .Xr bthidd 8 ,
-.Xr bthost 1 ,
 .Xr hccontrol 8 ,
 .Xr hcsecd 8 ,
 .Xr sdpcontrol 8 ,
@@ -107,5 +104,10 @@ utility first appeared in
 .Fx 12.1 .
 .Sh AUTHORS
 .An Dirk Engling Aq Mt erdgeist at erdgeist.org
+.Sh CAVEATS
+.Nm
+can not parse entries in
+.Xr hcsecd 8
+config file and thus will ask the user to manually modify existing pairing PIN entries.
 .Sh THANKS TO
 Lars Engels and Warren Block for suggestions, help, and testing.
diff --git a/usr.sbin/bluetooth/hccontrol/hccontrol.8 b/usr.sbin/bluetooth/hccontrol/hccontrol.8
index a31118b66895..d38db6bb24b1 100644
--- a/usr.sbin/bluetooth/hccontrol/hccontrol.8
+++ b/usr.sbin/bluetooth/hccontrol/hccontrol.8
@@ -146,8 +146,8 @@ are:
 .It Cm Get_Link_Quality
 .It Cm Read_RSSI
 .It Cm LE_Read_Local_Supported_Features
-.It Cm LE_Set_Advertising_Parameters 
-.It Cm LE_Read_Advertising_Physical_Channel_Tx_Power 
+.It Cm LE_Set_Advertising_Parameters
+.It Cm LE_Read_Advertising_Physical_Channel_Tx_Power
 .It Cm LE_Set_Advertising_Data
 .It Cm LE_Set_Scan_Response_Data
 .It Cm LE_Set_Advertising_Enable
@@ -181,10 +181,11 @@ are:
 .It Cm Write_Node_Role_Switch
 .It Cm Read_Node_List
 .El
+.Sh EXIT STATUS
+.Ex -std
 .Sh EXAMPLES
 Make the blutooth LE host, ubt0hci, scannable through
 .Xr hccontrol 8 commands:
-.Pp
 .Bd -literal -offset indent
 hccontrol -n ubt0hci le_set_advertising_enable disable
 hccontrol -n ubt0hci le_set_advertising_param
@@ -193,8 +194,6 @@ hccontrol -n ubt0hci le_set_advertising_data
 hccontrol -n ubt0hci le_set_scan_response -n FBSD_Host
 hccontrol -n ubt0hci le_set_advertising_enable enable
 .Ed
-.Sh EXIT STATUS
-.Ex -std
 .Sh SEE ALSO
 .Xr bluetooth 3 ,
 .Xr netgraph 3 ,
diff --git a/usr.sbin/bluetooth/hcseriald/hcseriald.8 b/usr.sbin/bluetooth/hcseriald/hcseriald.8
index c2d94efd0744..15f08411f98d 100644
--- a/usr.sbin/bluetooth/hcseriald/hcseriald.8
+++ b/usr.sbin/bluetooth/hcseriald/hcseriald.8
@@ -69,7 +69,7 @@ Example:
 .El
 .Sh FILES
 .Bl -tag -width ".Pa /var/run/hcserial. Ns Ar * Ns Pa .pid" -compact
-.It Pa /var/run/hcserial. Ns Ar * Ns Pa .pid
+.It Pa /var/run/hcserial . Ns Ar * Ns Pa .pid
 Process ID of the currently running
 .Nm
 daemon.
diff --git a/usr.sbin/bluetooth/sdpd/sdpd.8 b/usr.sbin/bluetooth/sdpd/sdpd.8
index 6a7b162a43a5..17040663a7ac 100644
--- a/usr.sbin/bluetooth/sdpd/sdpd.8
+++ b/usr.sbin/bluetooth/sdpd/sdpd.8
@@ -98,7 +98,16 @@ was started as root.
 The default user name is
 .Dq Li nobody .
 .El
-.Sh CAVEAT
+.Sh FILES
+.Bl -tag -width ".Pa /var/run/sdp" -compact
+.It Pa /var/run/sdp
+.El
+.Sh SEE ALSO
+.Xr sdp 3 ,
+.Xr sdpcontrol 8
+.Sh AUTHORS
+.An Maksim Yevmenkin Aq Mt m_evmenkin at yahoo.com
+.Sh CAVEATS
 The
 .Nm
 daemon
@@ -126,15 +135,6 @@ It only performs minimal checking on the service data sent in the Service
 Register request.
 It is assumed that application must obtain all required resources such
 as RFCOMM channels etc., before registering the service.
-.Sh FILES
-.Bl -tag -width ".Pa /var/run/sdp" -compact
-.It Pa /var/run/sdp
-.El
-.Sh SEE ALSO
-.Xr sdp 3 ,
-.Xr sdpcontrol 8
-.Sh AUTHORS
-.An Maksim Yevmenkin Aq Mt m_evmenkin at yahoo.com
 .Sh BUGS
 Most likely.
 Please report if found.
