# \[RFC PATCH 1/3\] Documentation/security: Update LSM security hook text

- From: Richard Haines \<hidden\>
- Date: 2021-03-09 14:46:11 
- List: linux-security-module
- Page: https://ratatoskr.run/linux-security-module/2021/03/8525005
- Thread: https://ratatoskr.run/linux-security-module/2021/03/8525007/t.md

```text
This patch series updates the LSM hook text defined in the comments
section of inlcude/linux/lsm_hooks.h.

This enables the hook functions to be rendered in kernel_docs html or
pdf format.

Note that no text has been changed in lsm_hooks.h, only formatting
to render the text.

Signed-off-by: Richard Haines <redacted>
---
 Documentation/security/lsm-development.rst | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/Documentation/security/lsm-development.rst b/Documentation/security/lsm-development.rst
index ac53e5065..f85897814 100644
--- a/Documentation/security/lsm-development.rst
+++ b/Documentation/security/lsm-development.rst
@@ -11,7 +11,10 @@ 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 ``include/linux/lsm_hooks.h`` and associated structures.
+
+The LSM hooks are described below in the ``RET (*NAME)(__VA_ARGS__)`` format
+under the `Description` header.
 
 .. kernel-doc:: include/linux/lsm_hooks.h
    :internal:
-- 
2.29.2

```