From: Richard Haines <richard_c_haines@btinternet.com>
To: linux-security-module@vger.kernel.org, linux-doc@vger.kernel.org
Cc: corbet@lwn.net, paul@paul-moore.com, jmorris@namei.org,
serge@hallyn.com, casey@schaufler-ca.com,
Richard Haines <richard_c_haines@btinternet.com>
Subject: [PATCH 1/3] Documentation/security: Update LSM security hook text
Date: Fri, 16 Apr 2021 13:28:41 +0100 [thread overview]
Message-ID: <20210416122843.4752-2-richard_c_haines@btinternet.com> (raw)
In-Reply-To: <20210416122843.4752-1-richard_c_haines@btinternet.com>
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 <richard_c_haines@btinternet.com>
---
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.30.2
next prev parent reply other threads:[~2021-04-16 12:30 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-04-16 12:28 [PATCH 0/3] LSM Documentation - Render lsm_hooks.h for kernel_docs Richard Haines
2021-04-16 12:28 ` Richard Haines [this message]
2021-04-16 12:28 ` [PATCH 2/3] include/linux: Update LSM hook text part1 Richard Haines
2021-04-16 12:28 ` [PATCH 3/3] include/linux: Update LSM hook text part2 Richard Haines
2021-04-16 16:43 ` [PATCH 0/3] LSM Documentation - Render lsm_hooks.h for kernel_docs Casey Schaufler
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210416122843.4752-2-richard_c_haines@btinternet.com \
--to=richard_c_haines@btinternet.com \
--cc=casey@schaufler-ca.com \
--cc=corbet@lwn.net \
--cc=jmorris@namei.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-security-module@vger.kernel.org \
--cc=paul@paul-moore.com \
--cc=serge@hallyn.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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).