git: 26eeda7bd656 - main - safexel manuals: Improve apropos and HW relnotes

The branch main has been updated by ziaee:

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

commit 26eeda7bd65603cdc6ff764349f55416b9766b43
Author:     Alexander Ziaee <ziaee@FreeBSD.org>
AuthorDate: 2024-11-22 17:45:36 +0000
Commit:     Alexander Ziaee <ziaee@FreeBSD.org>
CommitDate: 2025-02-24 16:13:38 +0000

    safexel manuals: Improve apropos and HW relnotes
    
    safe.4:
    Improve document description (Nd) for apropos. Remove Nm from sysctls
    in synopsis. This was causing this page to get pulled into results for
    `apropos sysctl`. Instead, use kernel declaration macros like vt(4).
    Convert the HARDWARE tagged list to a column list for better rendering
    in HW Relnotes. Tested in man(1) at MANWIDTH 59 and 80.
    
    safexcel.4:
    Nd: s/security packet/cryptographic offload/ for apropos.
    HARDWARE: Create this section for inclusion in the HW relnotes.
    
    SPDX:                   both tagged
    MFC after:              3 days
    MFC to:                 13.5
    Reported by:            markj (cryptographic offload, Inside Secure)
    Reviewed by:            jhb, markj, mhorne
    Accepted by:            markj (src), mhorne (mentor)
    Differential Revision:  https://reviews.freebsd.org/D47706
---
 share/man/man4/safe.4     | 34 +++++++++++++++++++---------------
 share/man/man4/safexcel.4 | 13 ++++++++++---
 2 files changed, 29 insertions(+), 18 deletions(-)

diff --git a/share/man/man4/safe.4 b/share/man/man4/safe.4
index 61f2041ff333..89375d058bf7 100644
--- a/share/man/man4/safe.4
+++ b/share/man/man4/safe.4
@@ -1,4 +1,6 @@
-.\"-
+.\"
+.\" SPDX-License-Identifier: BSD-2-Clause
+.\"
 .\" Copyright (c) 2003	Sam Leffler, Errno Consulting
 .\" All rights reserved.
 .\"
@@ -22,13 +24,13 @@
 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
-.\"/
-.Dd July 29, 2020
+.\"
+.Dd November 22, 2024
 .Dt SAFE 4
 .Os
 .Sh NAME
 .Nm safe
-.Nd SafeNet crypto accelerator
+.Nd SafeNet SafeXcel 1141/1741 crypto accelerator
 .Sh SYNOPSIS
 To compile this driver into the kernel,
 place the following lines in your
@@ -46,11 +48,15 @@ module at boot time, place the following line in
 safe_load="YES"
 .Ed
 .Pp
-.Nm sysctl Va hw.safe.debug
-.Nm sysctl Va hw.safe.dump
-.Nm sysctl Va hw.safe.rnginterval
-.Nm sysctl Va hw.safe.rngbufsize
-.Nm sysctl Va hw.safe.rngmaxalarm
+In
+.Xr sysctl.conf 5 :
+.Bd -ragged -offset indent
+.Cd hw.safe.debug
+.Cd hw.safe.dump
+.Cd hw.safe.rnginterval
+.Cd hw.safe.rngbufsize
+.Cd hw.safe.rngmaxalarm
+.Ed
 .Sh DESCRIPTION
 The
 .Nm
@@ -106,15 +112,13 @@ to dump the hardware interrupt registers.
 .Sh HARDWARE
 The
 .Nm
-driver supports cards containing any of the following chips:
-.Bl -tag -width "SafeNet 1141" -offset indent
-.It SafeNet 1141
-The original chipset.
+driver supports the following SafeXcel chips:
+.Bl -column "SafeNet 1141" "The original chipset. Supports" -offset indent
+.It SafeNet 1141 Ta The original chipset.
 Supports DES, Triple-DES, AES, MD5, and SHA-1
 symmetric crypto operations, RNG, public key operations, and full IPsec
 packet processing.
-.It SafeNet 1741
-A faster version of the 1141.
+.It SafeNet 1741 Ta A faster version of the 1141.
 .El
 .Sh SEE ALSO
 .Xr crypt 3 ,
diff --git a/share/man/man4/safexcel.4 b/share/man/man4/safexcel.4
index d5e079822ecc..e14eebe40da2 100644
--- a/share/man/man4/safexcel.4
+++ b/share/man/man4/safexcel.4
@@ -1,4 +1,6 @@
-.\"-
+.\"
+.\" SPDX-License-Identifier: BSD-2-Clause
+.\"
 .\" Copyright (c) 2020 Rubicon Communications, LLC (Netgate)
 .\"
 .\" Redistribution and use in source and binary forms, with or without
@@ -22,12 +24,12 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.Dd July 29, 2020
+.Dd November 22, 2024
 .Dt SAFEXCEL 4
 .Os
 .Sh NAME
 .Nm safexcel
-.Nd Inside Secure SafeXcel-IP-97 security packet engine
+.Nd Inside Secure SafeXcel-IP-97 cryptographic offload engine
 .Sh SYNOPSIS
 To compile this driver into the kernel,
 place the following lines in your
@@ -69,6 +71,11 @@ AES-CCM
 .Nm
 also implements SHA1 and SHA2 transforms, and can combine AES-CBC and AES-CTR
 with SHA1-HMAC and SHA2-HMAC for encrypt-then-authenticate operations.
+.Sh HARDWARE
+The
+.Nm
+driver supports the cryptographic acceleration functions of the
+Inside Secure EIP-97 device found on some Marvell systems-on-chip.
 .Sh SEE ALSO
 .Xr crypto 4 ,
 .Xr ipsec 4 ,