From 29a81285a6e3464e2c7f720ebd1d0efdeec5b0b4 Mon Sep 17 00:00:00 2001 From: Alexander Ziaee Date: Sun, 6 Oct 2024 18:44:15 -0400 Subject: [PATCH] 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. Reported by: bz MFC after: 3 days --- share/man/man5/style.mdoc.5 | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/share/man/man5/style.mdoc.5 b/share/man/man5/style.mdoc.5 index 42dbc940074cfd..f3f1de6d72ef7e 100644 --- a/share/man/man5/style.mdoc.5 +++ b/share/man/man5/style.mdoc.5 @@ -74,6 +74,29 @@ 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 with a subsection for the type of hardware supported. +This enables clean generation of Hardware Release Notes. +.Pp +Supported subsections are as follows: +.Pp +.Bl -tag -offset indent -compact +.It Sx Disk Controllers +.It Sx Ethernet Interfaces +.It Sx FDDI Interfaces +.It Sx Wireless Network Interfaces +.It Sx Miscellaneous Networks +.It Sx Serial Interfaces +.It Sx Sound Devices +.It Sx Cameras and Video Capture Devices +.It Sx Sound Devices +.It Sx IEEE 1394 (Firewire) Devices +.It Sx Bluetooth Devices +.It Sx Cryptographic Accelerators +.It Sx Miscellaneous +.El .Ss EXAMPLES Section .Bl -dash -width "" .It