linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Kees Cook <keescook@chromium.org>
To: Jonathan Corbet <corbet@lwn.net>
Cc: linux-kernel@vger.kernel.org,
	Masahiro Yamada <masahiroy@kernel.org>,
	Michal Marek <michal.lkml@markovi.net>,
	linux-doc@vger.kernel.org
Subject: Re: [PATCH 0/3] Better organize the core-api manual
Date: Mon, 2 Mar 2020 14:59:43 -0800	[thread overview]
Message-ID: <202003021456.F173F9DFC7@keescook> (raw)
In-Reply-To: <20200302223957.905473-1-corbet@lwn.net>

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

  parent reply	other threads:[~2020-03-02 22:59 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-03-02 22:39 [PATCH 0/3] Better organize the core-api manual Jonathan Corbet
2020-03-02 22:39 ` [PATCH 1/3] docs: Organize core-api/index.rst Jonathan Corbet
2020-03-02 22:39 ` [PATCH 2/3] docs: move gcc-plugins to the kbuild manual Jonathan Corbet
2020-03-05  2:12   ` Masahiro Yamada
2020-03-02 22:39 ` [PATCH 3/3] docs: move core-api/ioctl.rst to driver-api/ Jonathan Corbet
2020-03-02 22:59 ` Kees Cook [this message]
2020-03-02 23:23   ` [PATCH 0/3] Better organize the core-api manual Jonathan Corbet

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=202003021456.F173F9DFC7@keescook \
    --to=keescook@chromium.org \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=masahiroy@kernel.org \
    --cc=michal.lkml@markovi.net \
    /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).