Commit 6d2ed653 authored Apr 27, 2023 by Randy Dunlap Committed by Paul Moore Apr 28, 2023

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: e261301c ("lsm: move the remaining LSM hook comments to security/security.c")
Fixes: 1cd2aca6 ("lsm: move the io_uring hook comments to security/security.c")
Fixes: 452b670c ("lsm: move the perf hook comments to security/security.c")
Fixes: 55e85320 ("lsm: move the bpf hook comments to security/security.c")
Fixes: b14faf9c ("lsm: move the audit hook comments to security/security.c")
Fixes: 1427ddbe ("lsm: move the binder hook comments to security/security.c")
Fixes: 43fad282 ("lsm: move the sysv hook comments to security/security.c")
Fixes: ecc419a4 ("lsm: move the key hook comments to security/security.c")
Fixes: 742b9945 ("lsm: move the xfrm hook comments to security/security.c")
Fixes: ac318aed ("lsm: move the Infiniband hook comments to security/security.c")
Fixes: 4a49f592 ("lsm: move the SCTP hook comments to security/security.c")
Fixes: 6b6bbe8c ("lsm: move the socket hook comments to security/security.c")
Fixes: 2c2442fd ("lsm: move the AF_UNIX hook comments to security/security.c")
Fixes: 2bcf51bf ("lsm: move the netlink hook comments to security/security.c")
Fixes: 130c53bf ("lsm: move the task hook comments to security/security.c")
Fixes: a0fd6480 ("lsm: move the file hook comments to security/security.c")
Fixes: 9348944b ("lsm: move the kernfs hook comments to security/security.c")
Fixes: 916e3258 ("lsm: move the inode hook comments to security/security.c")
Fixes: 08526a90 ("lsm: move the filesystem hook comments to security/security.c")
Fixes: 36819f18 ("lsm: move the fs_context hook comments to security/security.c")
Fixes: 1661372c ("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>

parent d82dcd9e

Documentation/bpf/prog_lsm.rst

+1 −1

Original line number	Diff line number	Diff line
		@@ -18,7 +18,7 @@ LSM hook:
		.. c:function:: int file_mprotect(struct vm_area_struct *vma, unsigned long reqprot, unsigned long prot);

		Other LSM hooks which can be instrumented can be found in
		``include/linux/lsm_hooks.h``.
		``security/security.c``.

		eBPF programs that use Documentation/bpf/btf.rst do not need to include kernel
		headers for accessing information from the attached eBPF program's context.

Documentation/security/lsm-development.rst

+3 −3

Original line number	Diff line number	Diff line
		@@ -11,7 +11,7 @@ that end users and distros can make a more informed decision about which
		LSMs suit their requirements.

		For extensive documentation on the available LSM hook interfaces, please
		see ``include/linux/lsm_hooks.h`` and associated structures:
		see ``security/security.c`` and associated structures:

		.. kernel-doc:: include/linux/lsm_hooks.h
		:internal:
		.. kernel-doc:: security/security.c
		:export:

Documentation/security/lsm.rst

+1 −1

Original line number	Diff line number	Diff line
		@@ -98,7 +98,7 @@ associate these values with real security attributes.
		LSM hooks are maintained in lists. A list is maintained for each
		hook, and the hooks are called in the order specified by CONFIG_LSM.
		Detailed documentation for each hook is
		included in the `include/linux/lsm_hooks.h` header file.
		included in the `security/security.c` source file.

		The LSM framework provides for a close approximation of
		general security module stacking. It defines