[RFC PATCH] seccomp.2: Document why each header is needed

From: Alejandro Colomar <hidden>
Date: 2021-05-15 18:24:49
Subsystem: the rest · Maintainer: Linus Torvalds

Signed-off-by: Alejandro Colomar <redacted>
Cc: Kees Cook <redacted>
Cc: Tyler Hicks <redacted>
Cc: Will Drewry <wad@chromium.org>
Cc: Michael Kerrisk <redacted>
---

Hi,

I'm not sure about this one.  Please check if these are correct, and if some
include is missing or can be removed, according to what we're doing with the
other pages.

Cheers,

Alex

 man2/seccomp.2 | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/man2/seccomp.2 b/man2/seccomp.2
index 584a16f22..1be7d6766 100644
--- a/man2/seccomp.2
+++ b/man2/seccomp.2
@@ -30,11 +30,11 @@
 seccomp \- operate on Secure Computing state of the process
 .SH SYNOPSIS
 .nf
-.B #include <linux/seccomp.h>
-.B #include <linux/filter.h>
-.B #include <linux/audit.h>
-.B #include <linux/signal.h>
-.B #include <sys/ptrace.h>
+.BR "#include <linux/seccomp.h>" "  /* Definition of " SECCOMP_* " constants */"
+.BR "#include <linux/filter.h>" "   /* Definition of " "struct sock_fprog" " */"
+.BR "#include <linux/audit.h>" "    /* Definition of " AUDIT_* " constants */"
+.BR "#include <linux/signal.h>" "   /* Definition of " SIG* " constants */"
+.BR "#include <sys/ptrace.h>" "     /* Definition of " PTRACE_* " constants */"
 .\" Kees Cook noted: Anything that uses SECCOMP_RET_TRACE returns will
 .\"                  need <sys/ptrace.h>
 .PP
-- 
2.31.1
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help