git: 241fb89acdd2 - stable/14 - mdoc.7/MANUAL STRUCTURE: add HARDWARE
- Go to: [ bottom of page ] [ top of archives ] [ this month ]
Date: Mon, 14 Jul 2025 16:47:18 UTC
The branch stable/14 has been updated by ziaee:
URL: https://cgit.FreeBSD.org/src/commit/?id=241fb89acdd2971c9cdc300db1f0aad4e5d254cd
commit 241fb89acdd2971c9cdc300db1f0aad4e5d254cd
Author: Alexander Ziaee <concussious@runbox.com>
AuthorDate: 2024-10-13 15:03:14 +0000
Commit: Alexander Ziaee <ziaee@FreeBSD.org>
CommitDate: 2025-07-14 16:44:45 +0000
mdoc.7/MANUAL STRUCTURE: add HARDWARE
FreeBSD Release infrastructure has been generating the Hardware
Compatibility Notes from this section for some decades. Make this more
obvious. This does change the upstream mdoc.7 in a minimal way to
document this, but the .Dd wasn't bumped to avoid conflicts with the
next mdoc/mandoc import.
Reported by: bz (HARDWAREs generating compatibility notes)
Reported by: grahamperrin (order listed in fdp-primer/man)
Reviewed by: imp
Pull Request: https://github.com/freebsd/freebsd-src/pull/1463
(cherry picked from commit d235f19d1bf1e3d9ca31822709464cc6250f44c2)
---
contrib/mandoc/mdoc.7 | 7 +++++++
1 file changed, 7 insertions(+)
diff --git a/contrib/mandoc/mdoc.7 b/contrib/mandoc/mdoc.7
index 0eb697f9f0a7..9dbce2127361 100644
--- a/contrib/mandoc/mdoc.7
+++ b/contrib/mandoc/mdoc.7
@@ -137,6 +137,9 @@ The
utility processes files ...
\&.\e\(dq .Sh CONTEXT
\&.\e\(dq For section 9 functions only.
+\&.\e\(dq .Sh HARDWARE
+\&.\e\(dq For section 4 only.
+\&.\e\(dq Not used in OpenBSD.
\&.\e\(dq .Sh IMPLEMENTATION NOTES
\&.\e\(dq Not used in OpenBSD.
\&.\e\(dq .Sh RETURN VALUES
@@ -328,6 +331,10 @@ manual.
.It Em CONTEXT
This section lists the contexts in which functions can be called in section 9.
The contexts are autoconf, process, or interrupt.
+.It Em HARDWARE
+This section lists the hardware support
+provided by kernel modules in section 4.
+FreeBSD Hardware Compatibility Notes are generated from this section.
.It Em IMPLEMENTATION NOTES
Implementation-specific notes should be kept here.
This is useful when implementing standard functions that may have side