Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

lsm: move hook comments docs to security/security.c

Fix one kernel-doc warning, but invesigating that led to other
kernel-doc movement (lsm_hooks.h to security.c) that needs to be
fixed also.

include/linux/lsm_hooks.h:1: warning: no structured comments found

Fixes: e261301c851a ("lsm: move the remaining LSM hook comments to security/security.c")
Fixes: 1cd2aca64a5d ("lsm: move the io_uring hook comments to security/security.c")
Fixes: 452b670c7222 ("lsm: move the perf hook comments to security/security.c")
Fixes: 55e853201a9e ("lsm: move the bpf hook comments to security/security.c")
Fixes: b14faf9c94a6 ("lsm: move the audit hook comments to security/security.c")
Fixes: 1427ddbe5cc1 ("lsm: move the binder hook comments to security/security.c")
Fixes: 43fad2821876 ("lsm: move the sysv hook comments to security/security.c")
Fixes: ecc419a44535 ("lsm: move the key hook comments to security/security.c")
Fixes: 742b99456e86 ("lsm: move the xfrm hook comments to security/security.c")
Fixes: ac318aed5498 ("lsm: move the Infiniband hook comments to security/security.c")
Fixes: 4a49f592e931 ("lsm: move the SCTP hook comments to security/security.c")
Fixes: 6b6bbe8c02a1 ("lsm: move the socket hook comments to security/security.c")
Fixes: 2c2442fd46cd ("lsm: move the AF_UNIX hook comments to security/security.c")
Fixes: 2bcf51bf2f03 ("lsm: move the netlink hook comments to security/security.c")
Fixes: 130c53bfee4b ("lsm: move the task hook comments to security/security.c")
Fixes: a0fd6480de48 ("lsm: move the file hook comments to security/security.c")
Fixes: 9348944b775d ("lsm: move the kernfs hook comments to security/security.c")
Fixes: 916e32584dfa ("lsm: move the inode hook comments to security/security.c")
Fixes: 08526a902cc4 ("lsm: move the filesystem hook comments to security/security.c")
Fixes: 36819f185590 ("lsm: move the fs_context hook comments to security/security.c")
Fixes: 1661372c912d ("lsm: move the program execution hook comments to security/security.c")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Paul Moore <paul@paul-moore.com>
Cc: James Morris <jmorris@namei.org>
Cc: "Serge E. Hallyn" <serge@hallyn.com>
Cc: linux-security-module@vger.kernel.org
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
Cc: KP Singh <kpsingh@kernel.org>
Cc: bpf@vger.kernel.org
Signed-off-by: Paul Moore <paul@paul-moore.com>

authored by

Randy Dunlap and committed by
Paul Moore
6d2ed653 d82dcd9e

+5 -5
+1 -1
Documentation/bpf/prog_lsm.rst
··· 18 18 .. c:function:: int file_mprotect(struct vm_area_struct *vma, unsigned long reqprot, unsigned long prot); 19 19 20 20 Other LSM hooks which can be instrumented can be found in 21 - ``include/linux/lsm_hooks.h``. 21 + ``security/security.c``. 22 22 23 23 eBPF programs that use Documentation/bpf/btf.rst do not need to include kernel 24 24 headers for accessing information from the attached eBPF program's context.
+3 -3
Documentation/security/lsm-development.rst
··· 11 11 LSMs suit their requirements. 12 12 13 13 For extensive documentation on the available LSM hook interfaces, please 14 - see ``include/linux/lsm_hooks.h`` and associated structures: 14 + see ``security/security.c`` and associated structures: 15 15 16 - .. kernel-doc:: include/linux/lsm_hooks.h 17 - :internal: 16 + .. kernel-doc:: security/security.c 17 + :export:
+1 -1
Documentation/security/lsm.rst
··· 98 98 LSM hooks are maintained in lists. A list is maintained for each 99 99 hook, and the hooks are called in the order specified by CONFIG_LSM. 100 100 Detailed documentation for each hook is 101 - included in the `include/linux/lsm_hooks.h` header file. 101 + included in the `security/security.c` source file. 102 102 103 103 The LSM framework provides for a close approximation of 104 104 general security module stacking. It defines