diff options
| author | sigsegv7 <ian@vegaa.systems> | 2023-10-06 18:04:10 -0400 |
|---|---|---|
| committer | sigsegv7 <ian@vegaa.systems> | 2023-10-06 18:04:10 -0400 |
| commit | 2d65812fc852ce6f3d2e6d390be57856b3dcd80f (patch) | |
| tree | 355733c9eee45bf882f692c1da294779f93be8c8 /sys/include | |
| parent | 666fc435633ea3a5a61c077d414e6a5861698792 (diff) | |
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>
Diffstat (limited to 'sys/include')
| -rw-r--r-- | sys/include/sys/mmio.h | 4 | ||||
| -rw-r--r-- | sys/include/sys/syslog.h | 4 |
2 files changed, 8 insertions, 0 deletions
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_ |