Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

style.mdoc: Add HARDWARE #1451

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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,9 +74,32 @@
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
Format the
.Sx EXAMPLES
section in the following way:
Expand Down
Loading