From: Daniel Jordan <daniel.m.jordan@oracle.com>
To: Jonathan Corbet <corbet@lwn.net>
Cc: Daniel Jordan <daniel.m.jordan@oracle.com>,
Herbert Xu <herbert@gondor.apana.org.au>,
Steffen Klassert <steffen.klassert@secunet.com>,
Eric Biggers <ebiggers@kernel.org>,
linux-crypto@vger.kernel.org, linux-kernel@vger.kernel.org,
linux-doc@vger.kernel.org
Subject: Re: [PATCH 1/4] padata: update documentation
Date: Thu, 21 Nov 2019 09:36:13 -0500 [thread overview]
Message-ID: <20191121143613.xofz7dkpy7e5wtqe@ca-dmjordan1.us.oracle.com> (raw)
In-Reply-To: <20191120121634.6d989088@lwn.net>
On Wed, Nov 20, 2019 at 12:16:34PM -0700, Jonathan Corbet wrote:
> This all seems fine - it's better than not doing it - but can I put in a
> request or two?
>
> - This document is already formatted as RST, and your changes continue
> that. Can we please move it to Documentation/core-api/padata.rst and
> add it to the TOC tree there? Then it can become part of our formatted
> docs.
>
> - The padata code seems to be nicely equipped with kerneldoc comments; it
> would be awfully nice to pull them into the document directly rather
> than replicating the API there. (Why does the document do that now?
> Blame the bozo who originally wrote it :) That would make the document
> more complete and easier to maintain going forward.
Ok. It would be nice to preserve the how-to aspect of the original doc as
well, in other words, the order the interfaces should be called in. Will do
both.
> For added goodness we could stick in an SPDX tag while we're at it.
I'll use the license from padata.c/h.
next prev parent reply other threads:[~2019-11-21 14:36 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-11-20 18:54 [PATCH 0/4] padata lockdep, cpumask, and doc fixes Daniel Jordan
2019-11-20 18:54 ` [PATCH 1/4] padata: update documentation Daniel Jordan
2019-11-20 19:16 ` Jonathan Corbet
2019-11-21 14:36 ` Daniel Jordan [this message]
2019-11-20 18:54 ` [PATCH 2/4] padata: remove reorder_objects Daniel Jordan
2019-11-20 18:54 ` [PATCH 3/4] padata: always acquire cpu_hotplug_lock before pinst->lock Daniel Jordan
2019-11-20 18:54 ` [PATCH 4/4] padata: remove cpumask change notifier Daniel Jordan
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=20191121143613.xofz7dkpy7e5wtqe@ca-dmjordan1.us.oracle.com \
--to=daniel.m.jordan@oracle.com \
--cc=corbet@lwn.net \
--cc=ebiggers@kernel.org \
--cc=herbert@gondor.apana.org.au \
--cc=linux-crypto@vger.kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=steffen.klassert@secunet.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).