aboutsummaryrefslogtreecommitdiff
path: root/share/man
diff options
context:
space:
mode:
Diffstat (limited to 'share/man')
-rw-r--r--share/man/man4/Makefile6
-rw-r--r--share/man/man4/agp.44
-rw-r--r--share/man/man4/hifn.4132
-rw-r--r--share/man/man4/rndtest.41
-rw-r--r--share/man/man4/upgt.44
-rw-r--r--share/man/man5/style.Makefile.524
-rw-r--r--share/man/man7/d.74
-rw-r--r--share/man/man7/stats.73
-rw-r--r--share/man/man7/tuning.73
-rw-r--r--share/man/man9/gone_in.942
-rw-r--r--share/man/man9/insmntque.96
-rw-r--r--share/man/man9/vn_fullpath.94
12 files changed, 59 insertions, 174 deletions
diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile
index e94e832a3f94..fe744776d9b3 100644
--- a/share/man/man4/Makefile
+++ b/share/man/man4/Makefile
@@ -204,7 +204,6 @@ MAN= aac.4 \
hidbus.4 \
hidquirk.4 \
hidraw.4 \
- hifn.4 \
hkbd.4 \
hms.4 \
hmt.4 \
@@ -893,7 +892,6 @@ _ntb_hw_intel.4= ntb_hw_intel.4
_ntb_hw_plx.4= ntb_hw_plx.4
_ntb_transport.4=ntb_transport.4
_nvram.4= nvram.4
-_padlock.4= padlock.4
_pchtherm.4= pchtherm.4
_qat.4= qat.4
_qat_c2xxx.4= qat_c2xxx.4
@@ -940,6 +938,10 @@ _vmm.4= vmm.4
.endif
.endif
+.if ${MACHINE_CPUARCH} == "i386"
+_padlock.4= padlock.4
+.endif
+
.if ${MACHINE_CPUARCH} == "amd64" || ${MACHINE_CPUARCH} == "aarch64"
_hwt.4= hwt.4
.if ${MACHINE_CPUARCH} == "amd64"
diff --git a/share/man/man4/agp.4 b/share/man/man4/agp.4
index 2aeb01850085..b7a649117f36 100644
--- a/share/man/man4/agp.4
+++ b/share/man/man4/agp.4
@@ -22,7 +22,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.Dd November 28, 2007
+.Dd October 24, 2025
.Dt AGP 4
.Os
.Sh NAME
@@ -34,7 +34,7 @@
The
.Nm
driver is slated to be removed in
-.Fx 15.0 .
+.Fx 16.0 .
.Sh DESCRIPTION
The
.Nm
diff --git a/share/man/man4/hifn.4 b/share/man/man4/hifn.4
deleted file mode 100644
index 22494fcb6c6d..000000000000
--- a/share/man/man4/hifn.4
+++ /dev/null
@@ -1,132 +0,0 @@
-.\" $OpenBSD: hifn.4,v 1.32 2002/09/26 07:55:40 miod Exp $
-.\"
-.\" Copyright (c) 2000 Theo de Raadt
-.\" All rights reserved.
-.\"
-.\" Redistribution and use in source and binary forms, with or without
-.\" modification, are permitted provided that the following conditions
-.\" are met:
-.\" 1. Redistributions of source code must retain the above copyright
-.\" notice, this list of conditions and the following disclaimer.
-.\" 2. Redistributions in binary form must reproduce the above copyright
-.\" notice, this list of conditions and the following disclaimer in the
-.\" documentation and/or other materials provided with the distribution.
-.\"
-.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
-.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-.\" DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
-.\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
-.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
-.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
-.\" STRICT 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
-.Dt HIFN 4
-.Os
-.Sh NAME
-.Nm hifn
-.Nd Hifn 7751/7951/7811/7955/7956 crypto accelerator
-.Sh SYNOPSIS
-To compile this driver into the kernel,
-place the following lines in your
-kernel configuration file:
-.Bd -ragged -offset indent
-.Cd "device crypto"
-.Cd "device cryptodev"
-.Cd "device hifn"
-.Ed
-.Pp
-Alternatively, to load the driver as a
-module at boot time, place the following line in
-.Xr loader.conf 5 :
-.Bd -literal -offset indent
-hifn_load="YES"
-.Ed
-.Sh DESCRIPTION
-The
-.Nm
-driver supports various cards containing the Hifn 7751, 7951,
-7811, 7955, and 7956 chipsets.
-.Pp
-The
-.Nm
-driver registers itself to accelerate
-AES (7955 and 7956 only),
-SHA1, and SHA1-HMAC operations for
-.Xr ipsec 4
-and
-.Xr crypto 4 .
-.Pp
-The Hifn
-.Tn 7951 ,
-.Tn 7811 ,
-.Tn 7955 ,
-and
-.Tn 7956
-will also supply data to the kernel
-.Xr random 4
-subsystem.
-.Sh HARDWARE
-The
-.Nm
-driver supports various cards containing the Hifn 7751, 7951,
-7811, 7955, and 7956
-chipsets, such as:
-.Bl -tag -width namenamenamena -offset indent
-.It Invertex AEON
-No longer being made.
-Came as 128KB SRAM model, or 2MB DRAM model.
-.It Hifn 7751
-Reference board with 512KB SRAM.
-.It PowerCrypt
-Comes with 512KB SRAM.
-.It XL-Crypt
-Only board based on 7811 (which is faster than 7751 and has
-a random number generator).
-.It NetSec 7751
-Supports the most IPsec sessions, with 1MB SRAM.
-.It Soekris Engineering vpn1201 and vpn1211
-See
-.Pa http://www.soekris.com/ .
-Contains a 7951 and supports symmetric and random number operations.
-.It Soekris Engineering vpn1401 and vpn1411
-See
-.Pa http://www.soekris.com/ .
-Contains a 7955 and supports symmetric and random number operations.
-.El
-.Sh SEE ALSO
-.Xr crypto 4 ,
-.Xr intro 4 ,
-.Xr ipsec 4 ,
-.Xr random 4 ,
-.Xr crypto 7 ,
-.Xr crypto 9
-.Sh HISTORY
-The
-.Nm
-device driver appeared in
-.Ox 2.7 .
-The
-.Nm
-device driver was imported to
-.Fx 5.0 .
-.Sh CAVEATS
-The Hifn 9751 shares the same PCI ID.
-This chip is basically a 7751, but with the cryptographic functions missing.
-Instead, the 9751 is only capable of doing compression.
-Since we do not currently attempt to use any of these chips to do
-compression, the 9751-based cards are not useful.
-.Pp
-Support for the 7955 and 7956 is incomplete; the asymmetric crypto
-facilities are to be added and the performance is suboptimal.
-.Sh BUGS
-The 7751 chip starts out at initialization by only supporting compression.
-A proprietary algorithm, which has been reverse engineered, is required to
-unlock the cryptographic functionality of the chip.
-It is possible for vendors to make boards which have a lock ID not known
-to the driver, but all vendors currently just use the obvious ID which is
-13 bytes of 0.
diff --git a/share/man/man4/rndtest.4 b/share/man/man4/rndtest.4
index 9ed16caf3b87..c73302063cd3 100644
--- a/share/man/man4/rndtest.4
+++ b/share/man/man4/rndtest.4
@@ -49,7 +49,6 @@ is received from the device.
Failures are optionally reported on the console.
.Sh SEE ALSO
.Xr crypto 4 ,
-.Xr hifn 4 ,
.Xr random 4 ,
.Xr safe 4 ,
.Xr crypto 9
diff --git a/share/man/man4/upgt.4 b/share/man/man4/upgt.4
index 5d4ada1d1a1f..cc5775d252ac 100644
--- a/share/man/man4/upgt.4
+++ b/share/man/man4/upgt.4
@@ -48,7 +48,7 @@
.\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.Dd February 18, 2025
+.Dd October 24, 2025
.Dt UPGT 4
.Os
.Sh NAME
@@ -78,7 +78,7 @@ if_upgt_load="YES"
The
.Nm
driver is slated to be removed in
-.Fx 15.0 .
+.Fx 16.0 .
.Sh DESCRIPTION
The
.Nm
diff --git a/share/man/man5/style.Makefile.5 b/share/man/man5/style.Makefile.5
index fe8754924575..9a2f1b069d99 100644
--- a/share/man/man5/style.Makefile.5
+++ b/share/man/man5/style.Makefile.5
@@ -1,7 +1,7 @@
.\"
.\" SPDX-License-Identifier: BSD-3-Clause
.\"
-.\" Copyright (c) 2002-2003, 2023 David O'Brien <obrien@FreeBSD.org>
+.\" Copyright (c) 2002-2003, 2023, 2025 David O'Brien <deo@NUXI.org>
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
@@ -28,7 +28,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.Dd July 17, 2023
+.Dd October 29, 2025
.Dt STYLE.MAKEFILE 5
.Os
.Sh NAME
@@ -179,6 +179,21 @@ settings between the
and
.Fl I Ns 's.
.It
+Lists that span more than one line should be formatted as follows:
+.Bd -literal -offset indent
+SRCS+=<SP>\\
+<TAB>main.c<SP>\\
+<TAB>trace.c<SP>\\
+<TAB>zoo.c \\
+\&
+.Ed
+Specifically, the last item in the list should have a trailing '\\'.
+This is to avoid causing a "false diff" or "false blame" when
+a new item is appended at the end.
+In general the list should be English language alphabetized.
+A list of libraries or header inclusion paths are notable exceptions
+if needed for proper building.
+.It
Do not use GCCisms (such as
.Fl g
and
@@ -233,9 +248,6 @@ For variables that are only checked with
.Fn defined ,
do not provide any fake value.
.El
-.Pp
-The desire to express a logical grouping often means not obeying some of the
-above.
.Sh EXAMPLES
The simplest program
.Pa Makefile
@@ -270,5 +282,7 @@ manual page and first appeared in
.An David O'Brien Aq deo@NUXI.org
.Sh BUGS
There are few hard and fast style rules here.
+The desire to express a logical grouping sometimes means not obeying some of the
+above.
The style of many things is too dependent on the context of the whole makefile,
or the lines surrounding it.
diff --git a/share/man/man7/d.7 b/share/man/man7/d.7
index c098958ffa56..4b00d3d71c79 100644
--- a/share/man/man7/d.7
+++ b/share/man/man7/d.7
@@ -3,7 +3,7 @@
.\"
.\" Copyright (c) 2025 Mateusz Piotrowski <0mp@FreeBSD.org>
.\"
-.Dd September 24, 2025
+.Dd October 28, 2025
.Dt D 7
.Os
.Sh NAME
@@ -56,9 +56,9 @@ depends on
.Bl -column "thread-local" "Syntax"
.It Sy Type Ta Sy Syntax
.It global Ta Va variable_name
+.It aggregate Ta Sy @ Ns Va variable_name
.It thread-local Ta Sy self-> Ns Va variable_name
.It clause-local Ta Sy this-> Ns Va variable_name
-.It aggregate Ta Sy @ Ns Va variable_name
.El
.Pp
.Em Tips :
diff --git a/share/man/man7/stats.7 b/share/man/man7/stats.7
index 715db70e118b..0b57d525522c 100644
--- a/share/man/man7/stats.7
+++ b/share/man/man7/stats.7
@@ -24,7 +24,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.Dd April 22, 2021
+.Dd October 28, 2025
.Dt STATS 7
.Os
.Sh NAME
@@ -100,6 +100,7 @@ Report ZFS I/O statistics
.Xr stat 1 ,
.Xr systat 1 ,
.Xr intro 7 ,
+.Xr tuning 7 ,
.Xr ctlstat 8 ,
.Xr gstat 8 ,
.Xr ibstat 8 ,
diff --git a/share/man/man7/tuning.7 b/share/man/man7/tuning.7
index ebba551f65d0..44c427c4559d 100644
--- a/share/man/man7/tuning.7
+++ b/share/man/man7/tuning.7
@@ -22,7 +22,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.Dd January 23, 2025
+.Dd October 28, 2025
.Dt TUNING 7
.Os
.Sh NAME
@@ -678,6 +678,7 @@ over services you export from your box (web services, email).
.Xr firewall 7 ,
.Xr hier 7 ,
.Xr ports 7 ,
+.Xr stats 7 ,
.Xr boot 8 ,
.Xr bsdinstall 8 ,
.Xr ccdconfig 8 ,
diff --git a/share/man/man9/gone_in.9 b/share/man/man9/gone_in.9
index ebdc1ab19bfa..1b60e1eb10c2 100644
--- a/share/man/man9/gone_in.9
+++ b/share/man/man9/gone_in.9
@@ -23,7 +23,7 @@
.\" (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 August 16, 2021
+.Dd June 24, 2025
.Dt GONE_IN 9
.Os
.Sh NAME
@@ -33,14 +33,15 @@
.Sh SYNOPSIS
.In sys/systm.h
.Ft void
-.Fn gone_in "int major" "const char *msg"
+.Fn gone_in "int major" "const char *msg" "..."
.Ft void
-.Fn gone_in_dev "device_t dev" "int major" "const char *msg"
+.Fn gone_in_dev "device_t dev" "int major" "const char *msg" "..."
.Sh DESCRIPTION
The
-.Fn gone_in
-functions are used to provide a notice that the kernel is using a driver or
-some other functionality that is deprecated, and will be removed in a future
+.Nm gone_in
+functions are used to provide a notice that the kernel is actively using a
+driver or some other functionality that is deprecated, and is planned for
+removal in a future
.Fx
release.
The notice is sent to the kernel
@@ -51,30 +52,29 @@ The
argument specifies the major version of the
.Fx
release that will remove the deprecated functionality.
+The notice shall be printed only once, thus
+.Nm
+functions are safe to use in often executed code paths.
+.Pp
+.Nm gone_in_dev
+will prepend driver name before the notice.
.Pp
In releases before
.Fa major
-the deprecation notice states
-.Do
-Deprecated code (to be removed in FreeBSD
-.Fa major Ns ):
-.Fa msg
-.Dc .
-In releases equal to and after
-.Fa major
-the notice states
+the provided notice will be appended with
.Do
-Obsolete code will be removed soon:
-.Fa msg
+To be removed in FreeBSD
+.Fa major Ns
.Dc .
.Sh EXAMPLES
.Bd -literal -offset indent
void
-sample_init(void)
+example_api(foo_t *args)
{
- /* Initialization code omitted. */
+ gone_in(16, "Warning! %s[%u] uses obsolete API. ",
+ curthread->td_proc->p_comm, curthread->td_proc->p_pid);
- gone_in(14, "Giant-locked filesystem");
+ /* API implementation omitted. */
}
int
@@ -82,7 +82,7 @@ example_driver_attach(struct example_driver_softc *sc)
{
/* Attach code omitted. */
- gone_in_dev(sc->dev, 14, "Giant-locked driver");
+ gone_in_dev(sc->dev, 16, "driver is deprecated");
}
.Ed
.Sh HISTORY
diff --git a/share/man/man9/insmntque.9 b/share/man/man9/insmntque.9
index 869d8767632b..33ba697b10b9 100644
--- a/share/man/man9/insmntque.9
+++ b/share/man/man9/insmntque.9
@@ -24,7 +24,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
.\" DAMAGE.
.\"
-.Dd January 29, 2022
+.Dd October 24, 2025
.Dt INSMNTQUE 9
.Os
.Sh NAME
@@ -56,7 +56,7 @@ The vnode must be exclusively locked.
.Pp
On failure,
.Fn insmntque
-resets vnode' operation vector to the vector of
+resets vnode's operations vector to the vector of
.Xr deadfs 9 ,
clears
.Va v_data ,
@@ -71,7 +71,7 @@ failure is needed, the
function may be used instead.
It does not do any cleanup following a failure, leaving all
the work to the caller.
-In particular, the operation vector
+In particular, the operations vector
.Va v_op
and
.Va v_data
diff --git a/share/man/man9/vn_fullpath.9 b/share/man/man9/vn_fullpath.9
index 9815abc3c86c..af459ed281c0 100644
--- a/share/man/man9/vn_fullpath.9
+++ b/share/man/man9/vn_fullpath.9
@@ -107,7 +107,7 @@ than one name (hard links), not all file systems use the name cache
be used for more than one file (in the context of file systems covering
other file systems); a file may have no name (if deleted but still
open or referenced).
-However, the resulting string may still be more useable to a user than
+However, the resulting string may still be more usable to a user than
a vnode pointer value, or a device number and inode number.
Code consuming the results of this function should anticipate (and
properly handle) failure.
@@ -187,7 +187,7 @@ otherwise, an error number is returned.
.Xr free 9
.Sh AUTHORS
.An -nosplit
-This manual page was initally written by
+This manual page was initially written by
.An Robert Watson Aq Mt rwatson@FreeBSD.org
to describe the
.Fn vn_fullpath
generated by cgit v1.2.3 (git 2.25.1) at 2025-10-30 05:35:40 +0000