From 2d65812fc852ce6f3d2e6d390be57856b3dcd80f Mon Sep 17 00:00:00 2001 From: sigsegv7 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 --- sys/include/sys/mmio.h | 4 ++++ sys/include/sys/syslog.h | 4 ++++ 2 files changed, 8 insertions(+) (limited to 'sys/include') 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