git: 29eb4de61a4c - main - style.mdoc: HARDWARE generates Release Notes

The branch main has been updated by ziaee:

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

commit 29eb4de61a4c2ab1d940e10f3816db79e74d46b1
Author:     Alexander Ziaee <ziaee@FreeBSD.org>
AuthorDate: 2024-10-06 22:44:15 +0000
Commit:     Alexander Ziaee <ziaee@FreeBSD.org>
CommitDate: 2025-03-23 04:54:21 +0000

    style.mdoc: HARDWARE generates Release Notes
    
    FreeBSD Release Infrastructure has been building the Hardware
    Release Notes from these subsections in the Kernel Interfaces Manual.
    Standardize this behavior in the FreeBSD Manual page style guide with
    everything we learned in the 14.2-RELEASE.
    
    To me, this is an enormously exciting discovery, and I believe that
    over the next 5 years, this can transform the supported hardware UX,
    without reinventing the wheel, by doubling down on our ways instead
    of reinventing them.
    
    MFC after:              3 days
    Reported by:            bz (special thanks)
    Reviewed by:            imp, mhorne, pauamma, rpolaka
    Approved by:            mhorne (mentor)
    Differential Revision:  https://reviews.freebsd.org/D48343
---
 share/man/man5/style.mdoc.5 | 31 +++++++++++++++++++++++++++++--
 1 file changed, 29 insertions(+), 2 deletions(-)

diff --git a/share/man/man5/style.mdoc.5 b/share/man/man5/style.mdoc.5
index dd4d8a1f5fdf..d96c9ff08bbb 100644
--- a/share/man/man5/style.mdoc.5
+++ b/share/man/man5/style.mdoc.5
@@ -1,4 +1,4 @@
-.\"-
+.\"
 .\" SPDX-License-Identifier: BSD-2-Clause
 .\"
 .\" Copyright (c) 2018-2022 Mateusz Piotrowski <0mp@FreeBSD.org>
@@ -24,7 +24,7 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.Dd December 12, 2024
+.Dd December 21, 2024
 .Dt STYLE.MDOC 5
 .Os
 .Sh NAME
@@ -74,6 +74,33 @@ Historically,
 was the preferred way before the deprecation of
 .Sy \&Li .
 .El
+.Ss HARDWARE Section
+Driver manuals in section four should have a
+.Sx HARDWARE
+section describing hardware known to work with the driver.
+This section is drawn verbatim into the Release Hardware Notes,
+therefore there are several things to note:
+.Bl -dash -width ""
+.It
+The introductory sentence should be in the form:
+.Bd -literal -offset indent
+The
+\&.Nm
+driver supports the following $device_class:
+.Ed
+.Pp
+Followed by the list of supported hardware.
+.Pp
+This defines what driver the subsection is referring to,
+and allows the reader to search through the Hardware Notes
+not only for the device models they have,
+but also for the device type they are looking to acquire.
+.It
+The supported hardware should be listed as a bullet list,
+or if complexity requires, a column list.
+These two list types create very neat subsections
+with clean starting and stopping points.
+.El
 .Ss EXAMPLES Section
 .Bl -dash -width ""
 .It