lkml.org 
[lkml]   [2020]   [Mar]   [2]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: [PATCH 0/3] Better organize the core-api manual
On Mon, Mar 02, 2020 at 03:39:54PM -0700, Jonathan Corbet wrote:
> This is a brief series trying to create some order in the core-api manual.
> The first patch organizes the contents into subsections, hopefully
> straightening things out a bit. The other two then move a couple of
> documents to more suitable homes.
>
> Jonathan Corbet (3):
> docs: Organize core-api/index.rst
> docs: move gcc-plugins to the kbuild manual
> docs: move core-api/ioctl.rst to driver-api/

This looks good; thanks! Random thought while looking through it: there's
stuff in the driver-api that seems like maybe it should move into the
core (e.g. Documentation/driver-api/basics.rst) but I'm not sure what
the line between "core" and "driver" is. I would think the "driver API"
docs should be driver-specific, in which case much of basics.rst should
be moved into "core". Regardless, this series seems like a good step in
the right direction.

Reviewed-by: Kees Cook <keescook@chromium.org>

-Kees

>
> Documentation/core-api/index.rst | 93 ++++++++++++++-----
> Documentation/driver-api/index.rst | 1 +
> .../{core-api => driver-api}/ioctl.rst | 0
> .../{core-api => kbuild}/gcc-plugins.rst | 0
> Documentation/kbuild/index.rst | 1 +
> MAINTAINERS | 2 +-
> scripts/gcc-plugins/Kconfig | 2 +-
> 7 files changed, 75 insertions(+), 24 deletions(-)
> rename Documentation/{core-api => driver-api}/ioctl.rst (100%)
> rename Documentation/{core-api => kbuild}/gcc-plugins.rst (100%)
>
> --
> 2.24.1
>

--
Kees Cook

\
 
 \ /
  Last update: 2020-03-03 00:00    [W:0.048 / U:2.156 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site