Skip to contentSkip to conversation

doc: security: Add kern-doc for lsm_hooks.h

PATCH Applied Kees Cook 2 participants 2 messages Feb 17, 2019 – Feb 22, 2019

Subsystems (2)
lore
Share & tools
lore

Kees Cook

author
#0 lore raw

PATCH 1/1 doc: security: Add kern-doc for lsm_hooks.h

There is a lot of kern-doc for the LSM internals, but it wasn't visible in the HTML output. This exposes some formatting flaws in lsm_hooks.h that will be fixed in a later series of patches.

---
 Documentation/security/LSM.rst | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)
Documentation/security/LSM.rst +4 -1
index 8b9ee597e9d0..31d92bc5fdd2 100644
@@ -11,4 +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``.
+see ``include/linux/lsm_hooks.h`` and associated structures:
+
+.. kernel-doc:: include/linux/lsm_hooks.h
+   :internal:
Signature · 5 lines
2.17.1


-- 
Kees Cook
maintainer Applied
#1 lore raw
Quoted 5 lines · On Sun, 17 Feb 2019 14:19:01 -0800 Kees Cook <[email protected]> wrote:

There is a lot of kern-doc for the LSM internals, but it wasn't visible in the HTML output. This exposes some formatting flaws in lsm_hooks.h that will be fixed in a later series of patches.

Applied, thanks. That does add to our already overwhelming pile of warnings, hopefully that later series is showing up soon :)

jon