linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH] doc: security: Add kern-doc for lsm_hooks.h
@ 2019-02-17 22:19 Kees Cook
  2019-02-22 15:55 ` Jonathan Corbet
  0 siblings, 1 reply; 2+ messages in thread
From: Kees Cook @ 2019-02-17 22:19 UTC (permalink / raw)
  To: Jonathan Corbet
  Cc: efremov, James Morris, linux-doc, linux-security-module, LKML

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(-)

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:
-- 
2.17.1


-- 
Kees Cook

^ permalink raw reply related	[flat|nested] 2+ messages in thread

* Re: [PATCH] doc: security: Add kern-doc for lsm_hooks.h
  2019-02-17 22:19 [PATCH] doc: security: Add kern-doc for lsm_hooks.h Kees Cook
@ 2019-02-22 15:55 ` Jonathan Corbet
  0 siblings, 0 replies; 2+ messages in thread
From: Jonathan Corbet @ 2019-02-22 15:55 UTC (permalink / raw)
  To: Kees Cook; +Cc: efremov, James Morris, linux-doc, linux-security-module, LKML

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

^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2019-02-22 15:55 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-02-17 22:19 [PATCH] doc: security: Add kern-doc for lsm_hooks.h Kees Cook
2019-02-22 15:55 ` Jonathan Corbet

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).