Skip site navigation (1)Skip section navigation (2)
Date:      Fri, 7 Feb 2025 19:02:01 GMT
From:      Warner Losh <imp@FreeBSD.org>
To:        src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-main@FreeBSD.org
Subject:   git: d235f19d1bf1 - main - mdoc.7/MANUAL STRUCTURE: add HARDWARE
Message-ID:  <202502071902.517J21OF087144@gitrepo.freebsd.org>

next in thread | raw e-mail | index | archive | help
The branch main has been updated by imp:

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

commit d235f19d1bf1e3d9ca31822709464cc6250f44c2
Author:     Alexander Ziaee <concussious@runbox.com>
AuthorDate: 2024-10-13 15:03:14 +0000
Commit:     Warner Losh <imp@FreeBSD.org>
CommitDate: 2025-02-07 18:47:14 +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
---
 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



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?202502071902.517J21OF087144>