Skip to content

Commit

Permalink
style.mdoc: HARDWARE generates Release Notes
Browse files Browse the repository at this point in the history
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
  • Loading branch information
concussious committed Oct 7, 2024
1 parent 9147a0c commit 29a8128
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions share/man/man5/style.mdoc.5
Original file line number Diff line number Diff line change
Expand Up @@ -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

Check warning on line 102 in share/man/man5/style.mdoc.5

View workflow job for this annotation

GitHub Actions / Style Checker

Missing Signed-off-by: line

Check warning on line 102 in share/man/man5/style.mdoc.5

View workflow job for this annotation

GitHub Actions / Style Checker

Missing Signed-off-by: line

Check warning on line 102 in share/man/man5/style.mdoc.5

View workflow job for this annotation

GitHub Actions / Style Checker

Missing Signed-off-by: line

Check warning on line 102 in share/man/man5/style.mdoc.5

View workflow job for this annotation

GitHub Actions / Style Checker

Missing Signed-off-by: line

Check warning on line 102 in share/man/man5/style.mdoc.5

View workflow job for this annotation

GitHub Actions / Style Checker

Missing Signed-off-by: line

Check warning on line 102 in share/man/man5/style.mdoc.5

View workflow job for this annotation

GitHub Actions / Style Checker

Missing Signed-off-by: line
Expand Down

0 comments on commit 29a8128

Please sign in to comment.