Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]

Groups > linux.kernel > #1641924

Re: [PATCH 00/17] convert/reorganize Documentation/security/

Show all headers | View raw

On Mon, May 15, 2017 at 10:26 AM, Jonathan Corbet <corbet@lwn.net> wrote:
> On Sat, 13 May 2017 04:51:36 -0700
> Kees Cook <keescook@chromium.org> wrote:
>
>> This ReSTifies everything under Documentation/security/, and reorganizes
>> some of it (mainly the LSMs) under /admin-guide/ per Jon's request. Since
>> /security/ is already being indexed under the kernel development portion
>> of the sphinx index, I didn't move it, keeping only things that were
>> directly related to internal kernel development (keys, creds, etc).
>>
>> I also updated some path references, and MAINTAINERS lines. Some of the
>> conversion could probably do with some tweaks, but I think this is a
>> good first step in the right direction.
>
> This all looks pretty good to me, though I'll confess I haven't actually
> built the resulting docs yet.  Assuming no issues turn up there, I'd be
> happy to just apply these and let any follow-on tweaks go from there.
> Thanks for doing this, and for humoring me on the organizational issues :)

My local tree builds the docs sanely from what I can see, so if it
looks good to you too, yeah, please take these as they are. I'm sure
we'll need tweaks going forward, but this seems like the bulk of the
organizational and basic ReST work.

BTW, something I noticed in while doing this conversion is the
difference between the section headings and the left-side nav bar at
the top level:
https://www.kernel.org/doc/html/latest/index.html

The section names don't match, and each of the Kernel API
Documentation sections is at the top level in the nav bar. I think
this would be cleaner if everything matched up, but I didn't yet dig
into figuring out why they were different.

-Kees

-- 
Kees Cook
Pixel Security

Back to linux.kernel | Previous | Next — Previous in thread | Next in thread | Find similar | Unroll thread

Thread

[PATCH 00/17] convert/reorganize Documentation/security/ Kees Cook <keescook@chromium.org> - 2017-05-13 14:00 +0200
  [PATCH 16/17] doc: ReSTify keys-request-key.txt Kees Cook <keescook@chromium.org> - 2017-05-13 14:00 +0200
  [PATCH 04/17] doc: ReSTify credentials.txt Kees Cook <keescook@chromium.org> - 2017-05-13 14:00 +0200
  [PATCH 06/17] doc: security: minor cleanups to build kernel-doc Kees Cook <keescook@chromium.org> - 2017-05-13 14:00 +0200
    Re: [PATCH 06/17] doc: security: minor cleanups to build  kernel-doc James Morris <jmorris@namei.org> - 2017-05-15 01:20 +0200
      Re: [PATCH 06/17] doc: security: minor cleanups to build kernel-doc Jonathan Corbet <corbet@lwn.net> - 2017-05-15 19:30 +0200
    Re: [PATCH 06/17] doc: security: minor cleanups to build kernel-doc Casey Schaufler <casey@schaufler-ca.com> - 2017-05-15 02:10 +0200
      Re: [PATCH 06/17] doc: security: minor cleanups to build kernel-doc Kees Cook <keescook@chromium.org> - 2017-05-15 16:50 +0200
  [PATCH 12/17] doc: ReSTify LoadPin.txt Kees Cook <keescook@chromium.org> - 2017-05-13 14:00 +0200
  [PATCH 17/17] doc: ReSTify keys-trusted-encrypted.txt Kees Cook <keescook@chromium.org> - 2017-05-13 14:00 +0200
  [PATCH 05/17] doc: ReSTify self-protection.txt Kees Cook <keescook@chromium.org> - 2017-05-13 14:00 +0200
  [PATCH 03/17] doc: ReSTify IMA-templates.txt Kees Cook <keescook@chromium.org> - 2017-05-13 14:00 +0200
  [PATCH 02/17] doc: ReSTify no_new_privs.txt Kees Cook <keescook@chromium.org> - 2017-05-13 14:00 +0200
  [PATCH 13/17] doc: ReSTify Smack.txt Kees Cook <keescook@chromium.org> - 2017-05-13 14:00 +0200
    Re: [PATCH 13/17] doc: ReSTify Smack.txt Casey Schaufler <casey@schaufler-ca.com> - 2017-05-15 16:20 +0200
  [PATCH 07/17] doc: ReSTify and split LSM.txt Kees Cook <keescook@chromium.org> - 2017-05-13 14:00 +0200
  [PATCH 09/17] doc: ReSTify apparmor.txt Kees Cook <keescook@chromium.org> - 2017-05-13 14:00 +0200
    Re: [PATCH 09/17] doc: ReSTify apparmor.txt John Johansen <john.johansen@canonical.com> - 2017-05-13 21:50 +0200
  Re: [PATCH 00/17] convert/reorganize Documentation/security/ Jonathan Corbet <corbet@lwn.net> - 2017-05-15 19:30 +0200
    Re: [PATCH 00/17] convert/reorganize Documentation/security/ Kees Cook <keescook@chromium.org> - 2017-05-15 19:40 +0200
  Re: [PATCH 00/17] convert/reorganize Documentation/security/ Jonathan Corbet <corbet@lwn.net> - 2017-05-18 19:00 +0200
    Re: [PATCH 00/17] convert/reorganize Documentation/security/ Kees Cook <keescook@chromium.org> - 2017-05-18 19:10 +0200

csiph-web