Page MenuHomeFreeBSD
Files F156848964

D54586.id.diff
No OneTemporary
Actions

D54586.id.diff
View Options

diff --git a/contrib/mandoc/mdoc.7 b/contrib/mandoc/mdoc.7
--- a/contrib/mandoc/mdoc.7
+++ b/contrib/mandoc/mdoc.7
@@ -1183,11 +1183,18 @@
.It Ic \&Cd Ar line
Kernel configuration declaration.
This denotes strings accepted by
-.Xr config 8 .
+.Xr config 8
+or, on
+.Fx ,
+device hints,
+loader tunables,
+and sysctl nodes in
+.Em SYNOPSIS.
It is most often used in section 4 manual pages.
.Pp
Examples:
.Dl \&.Cd device le0 at scode?
+.Dl \&.Cd kern.vty=vt
.Pp
.Em Remarks :
this macro is commonly abused by using quoted literals to retain
diff --git a/share/examples/mdoc/example.4 b/share/examples/mdoc/example.4
--- a/share/examples/mdoc/example.4
+++ b/share/examples/mdoc/example.4
@@ -5,27 +5,29 @@
.\"
.\" Note: The date here should be updated whenever a non-trivial
.\" change is made to the manual page.
-.Dd July 31, 2015
-.Dt EXAMPLE 4 i386
+.Dd May 8, 2026
+.Dt EXAMPLE 4 amd64
.Os
.Sh NAME
.Nm example
.Nd example device driver manual page
.Sh SYNOPSIS
-To compile the driver into the kernel,
-place the following lines in the
-kernel configuration file:
-.Bd -ragged -offset indent
-.Cd "device example"
-.Cd "options EXAMPLE_DEBUG"
-.Ed
+.Cd device example
+.Cd options EXAMPLE_DEBUG
.Pp
-Alternatively, to load the driver as a
-module at boot time, place the following line in
+In
+.Xr device.hints 5 :
+.Cd here.is.a.example.device.hint Ns Ao Ns = Ns Ar optional_value Ac
+.Pp
+In
.Xr loader.conf 5 :
-.Bd -literal -offset indent
-example_load="YES"
-.Ed
+.Cd here.is.a.example.tunable Ns Ao Ns = Ns Ar optional_value Ac
+.Pp
+In
+.Xr loader.conf 5
+or
+.Xr sysctl.conf 5 :
+.Cd here.is.a.example.sysctl Ns Ao Ns = Ns Ar optional_value Ac
.Sh DEPRECATION NOTICE
This driver is scheduled for removal prior to the release of
.Fx 17.0 .
@@ -36,6 +38,10 @@
It is intended that this example can be used as a template
when writing a new manual page.
.Pp
+If the kernel is compiled with the
+.Dv EXAMPLE_DEBUG
+option, then additional debugging messages will be displayed.
+.Pp
The
.Nm
driver supports the following ioctls:
@@ -45,10 +51,6 @@
.It Dv EIOCNULL
Example ioctl.
.El
-.Pp
-If the kernel is compiled with the
-.Dv EXAMPLE_DEBUG
-option, then additional debugging messages will be displayed.
.Sh HARDWARE
The
.Nm
@@ -100,6 +102,8 @@
.At v6 .
.Sh AUTHORS
This manual page was written by
-.An Mike Pritchard Aq Mt mpp@FreeBSD.org .
+.An Mike Pritchard Aq Mt mpp@FreeBSD.org
+and
+.An Alexander Ziaee Aq Mt ziaee@FreeBSD.org .
.Sh BUGS
The actual code for this device driver is vaporware.

File Metadata

Mime Type
text/plain
Expires
Sun, May 17, 9:37 PM (2 h, 1 m)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
33211071
Default Alt Text
D54586.id.diff (2 KB)

Event Timeline