linux-security-module.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
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: [RFC PATCH 0/3] LSM Documentation - Render lsm_hooks.h for kernel_docs
Date: Tue,  9 Mar 2021 14:39:50 +0000	[thread overview]
Message-ID: <20210309143953.142341-1-richard_c_haines@btinternet.com> (raw)

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.

To get the correct rendering some lines have exceeded checkpatch limits and
therefore has a moan. The function statements seem to need being a
continuous line. The others can be split, but decided not to.
Any better ideas ??

The hook functions render in HTML ok, however in PDF format the only issue
is that the long function definitions do not wrap and therefore truncated.
Check the 'int sb_mount(const char *dev_name' entry in:
Documentation/output/pdf/security.pdf

For reference two hooks have been marked as deprecated: sb_copy_data() and
sb_parse_opts_str()

Tested using 'make pdfdocs' and 'make htmldocs'

Richard Haines (3):
  Documentation/security: Update LSM security hook text
  include/linux: Update LSM hook text part1
  include/linux: Update LSM hook text part2

 Documentation/security/lsm-development.rst |    5 +-
 include/linux/lsm_hooks.h                  | 2365 +++++++++++---------
 2 files changed, 1364 insertions(+), 1006 deletions(-)

-- 
2.29.2


             reply	other threads:[~2021-03-09 14:47 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-03-09 14:39 Richard Haines [this message]
2021-03-09 14:39 ` [RFC PATCH 1/3] Documentation/security: Update LSM security hook text Richard Haines
2021-03-09 14:39 ` [RFC PATCH 2/3] include/linux: Update LSM hook text part1 Richard Haines
2021-03-09 14:39 ` [RFC PATCH 3/3] include/linux: Update LSM hook text part2 Richard Haines
2021-04-08  1:42 ` [RFC PATCH 0/3] LSM Documentation - Render lsm_hooks.h for kernel_docs Paul Moore
2021-04-13 19:01   ` Serge E. Hallyn
2021-04-15 13:53     ` Richard Haines
2021-04-15 13:59       ` Paul Moore

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=20210309143953.142341-1-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).