diff mbox series

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

Message ID 20190217221901.GA41920@beast (mailing list archive)
State New, archived
Headers show
Series doc: security: Add kern-doc for lsm_hooks.h | expand

Commit Message

Kees Cook Feb. 17, 2019, 10:19 p.m. UTC
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.

Signed-off-by: Kees Cook <keescook@chromium.org>
---
 Documentation/security/LSM.rst | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

Comments

Jonathan Corbet Feb. 22, 2019, 3:55 p.m. UTC | #1
On Sun, 17 Feb 2019 14:19:01 -0800
Kees Cook <keescook@chromium.org> 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.
> 
> Signed-off-by: Kees Cook <keescook@chromium.org>

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

jon
diff mbox series

Patch

diff --git a/Documentation/security/LSM.rst b/Documentation/security/LSM.rst
index 8b9ee597e9d0..31d92bc5fdd2 100644
--- a/Documentation/security/LSM.rst
+++ b/Documentation/security/LSM.rst
@@ -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: