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 /share | |
| 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 'share')
| -rw-r--r-- | share/misc/style | 12 |
1 files changed, 11 insertions, 1 deletions
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 |