git: 0a5443da8143 - main - man4: Add a comment about Hardware Notes

From: Colin Percival <cperciva_at_FreeBSD.org>
Date: Sat, 14 Sep 2024 19:25:22 UTC
The branch main has been updated by cperciva:

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

commit 0a5443da8143f8242c652aaff4fe6226d4718ab6
Author:     Colin Percival <cperciva@FreeBSD.org>
AuthorDate: 2024-09-14 19:20:49 +0000
Commit:     Colin Percival <cperciva@FreeBSD.org>
CommitDate: 2024-09-14 19:23:31 +0000

    man4: Add a comment about Hardware Notes
    
    The Hardware Notes for each release are generated automatically from a
    template file and the HARDWARE sections of driver man pages.  When man
    pages for new drivers are added here, they should usually be added to
    the release notes template file.
    
    Suggested by:   bz
    Sponsored by:   Amazon
---
 share/man/man4/Makefile | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile
index 6195211d2eb9..ad4bc47acfea 100644
--- a/share/man/man4/Makefile
+++ b/share/man/man4/Makefile
@@ -1,5 +1,10 @@
 .include <src.opts.mk>
 
+# If you add a new file here, please consider adding an entry to the
+# hardware notes template (website/archetypes/release/hardware.adoc in
+# the doc repository); otherwise the automatically generated hardware
+# notes will not include your driver.
+
 MAN=	aac.4 \
 	aacraid.4 \
 	acpi.4 \