From 2d65812fc852ce6f3d2e6d390be57856b3dcd80f Mon Sep 17 00:00:00 2001
From: sigsegv7 <ian@vegaa.systems>
Date: Fri, 6 Oct 2023 18:04:10 -0400
Subject: kernel/docs: Add new convention

This commit adds a new convention that requires devs to
write a comment for headers that have a manpage tied to them
that shows which manpage it is tied to.

Signed-off-by: sigsegv7 <ian@vegaa.systems>
---
 share/misc/style         | 12 +++++++++++-
 sys/include/sys/mmio.h   |  4 ++++
 sys/include/sys/syslog.h |  4 ++++
 3 files changed, 19 insertions(+), 1 deletion(-)

diff --git a/share/misc/style b/share/misc/style
index 03bcc72..6732644 100644
--- a/share/misc/style
+++ b/share/misc/style
@@ -59,10 +59,20 @@ __KERNEL_META("$Vega$: style.c, Ian Marco Moffett, "
  * A header file should protect itself against
  * multiple inclusion.
  */
+
+/*
+ * If your header as a manpage tied to it use
+ * write a comment similar to the below comment
+ */
+
+/*
+ * For documentation: See syslog(9)
+ */
+
  #ifndef _SYS_FOO_H_
  #define _SYS_FOO_H_
 
- 
+
 /*
  * extern declarations must only appear in header files, not in .c
  * files, so the same declaration is used by the .c file defining it
diff --git a/sys/include/sys/mmio.h b/sys/include/sys/mmio.h
index 0cc1983..73761ce 100644
--- a/sys/include/sys/mmio.h
+++ b/sys/include/sys/mmio.h
@@ -27,6 +27,10 @@
  * POSSIBILITY OF SUCH DAMAGE.
  */
 
+/*
+ * For documentation: See mmio(9)
+ */
+
 #ifndef _SYS_MMIO_H_
 #define _SYS_MMIO_H_
 
diff --git a/sys/include/sys/syslog.h b/sys/include/sys/syslog.h
index 3472514..d05a5ff 100644
--- a/sys/include/sys/syslog.h
+++ b/sys/include/sys/syslog.h
@@ -27,6 +27,10 @@
  * POSSIBILITY OF SUCH DAMAGE.
  */
 
+/*
+ * For documentation: See syslog(9)
+ */
+
 #ifndef _SYS_SYSLOG_H_
 #define _SYS_SYSLOG_H_
 
-- 
cgit v1.2.3