From: Kees Cook <keescook@chromium.org>
To: efremov <efremov@ispras.ru>
Cc: linux-security-module <linux-security-module@vger.kernel.org>,
Casey Schaufler <casey@schaufler-ca.com>,
"Eric W. Biederman" <ebiederm@xmission.com>,
Eric Paris <eparis@parisplace.org>,
John Johansen <john.johansen@canonical.com>,
James Morris <jmorris@namei.org>,
"Serge E. Hallyn" <serge@hallyn.com>,
Paul Moore <paul@paul-moore.com>,
Kentaro Takeda <takedakn@nttdata.co.jp>,
LKML <linux-kernel@vger.kernel.org>
Subject: Re: [PATCH 00/10] LSM documentation update
Date: Sun, 17 Feb 2019 14:15:45 -0800 [thread overview]
Message-ID: <CAGXu5j+VMU3LT77KkyoAwuVAemfM0mayvBcy3Y0K_a7UDBL=ow@mail.gmail.com> (raw)
In-Reply-To: <67ff280b6867b9a594ee16b2ad83bb7f@ispras.ru>
On Sun, Feb 17, 2019 at 10:04 AM efremov <efremov@ispras.ru> wrote:
>
> Kees Cook писал 2019-02-11 22:28:
> > On Thu, Feb 7, 2019 at 4:45 AM Denis Efremov <efremov@ispras.ru> wrote:
> >>
> >> Recent "New LSM Hooks" discussion has led me to the
> >> thought that it might be a good idea to slightly
> >> update the current documentation. The patchset adds
> >> nothing new to the documentation, only fixes the old
> >> description of hooks to reflect their current state.
>
> >
> > Do these fixes silence any warnings during the documentation build?
> > (i.e. how did you verify the results beyond eyeballing the changes)
> >
> > -Kees
>
> This LSM documentation is not used during the documentation build.
> At least I can't find it in the resulting build directory and at
> the online documentation on the kernel. Most of the fixes are pretty
> obvious and can be checked by comparing an lsm hook declaration and
> its description in the LSM comment from lsm_hooks.h I tried to be
> exhaustive in the commits description and in every case to reference
> the original commit where the interface was changed without
> documentation update.
I'll send an official patch that'll hook this up. I've been meaning to
do it for a while, but there were several things that needed cleaning
up (and you've snagged most of them). So with this patch, you'll be
able to check the output for "make htmldocs" for lsm_hooks.h errors:
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:
--
Kees Cook
prev parent reply other threads:[~2019-02-17 22:16 UTC|newest]
Thread overview: 20+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-02-07 12:44 [PATCH 00/10] LSM documentation update Denis Efremov
2019-02-07 12:44 ` [PATCH 01/10] security: fix documentation for the sb_copy_data hook Denis Efremov
2019-02-07 12:44 ` [PATCH 02/10] security: fix documentation for the syslog hook Denis Efremov
2019-02-07 12:44 ` [PATCH 03/10] security: fix documentation for the socket_post_create hook Denis Efremov
2019-02-07 12:44 ` [PATCH 04/10] security: fix documentation for the task_setscheduler hook Denis Efremov
2019-02-07 12:44 ` [PATCH 05/10] security: fix documentation for the socket_getpeersec_dgram hook Denis Efremov
2019-02-07 12:44 ` [PATCH 06/10] security: fix documentation for the path_chmod hook Denis Efremov
2019-02-07 13:49 ` Al Viro
2019-02-07 14:09 ` Edwin Zimmerman
2019-02-07 14:32 ` Stephen Smalley
2019-02-07 14:55 ` Stephen Smalley
2019-02-07 14:46 ` Al Viro
2019-02-17 18:45 ` efremov
2019-02-07 12:44 ` [PATCH 07/10] security: fix documentation for the audit_* hooks Denis Efremov
2019-02-07 12:44 ` [PATCH 08/10] security: fix documentation for the msg_queue_* hooks Denis Efremov
2019-02-07 12:44 ` [PATCH 09/10] security: fix documentation for the sem_* hooks Denis Efremov
2019-02-07 12:44 ` [PATCH 10/10] security: fix documentation for the shm_* hooks Denis Efremov
2019-02-11 19:28 ` [PATCH 00/10] LSM documentation update Kees Cook
2019-02-17 18:04 ` efremov
2019-02-17 22:15 ` Kees Cook [this message]
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='CAGXu5j+VMU3LT77KkyoAwuVAemfM0mayvBcy3Y0K_a7UDBL=ow@mail.gmail.com' \
--to=keescook@chromium.org \
--cc=casey@schaufler-ca.com \
--cc=ebiederm@xmission.com \
--cc=efremov@ispras.ru \
--cc=eparis@parisplace.org \
--cc=jmorris@namei.org \
--cc=john.johansen@canonical.com \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-security-module@vger.kernel.org \
--cc=paul@paul-moore.com \
--cc=serge@hallyn.com \
--cc=takedakn@nttdata.co.jp \
/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).