Re: [PATCH 1/4] padata: update documentation

From: Daniel Jordan
Date: Thu Nov 21 2019 - 09:36:23 EST


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.