Re: [RFC PATCH v4 01/13] ktask: add documentation

Daniel Jordan
2018-11-08T19:15:53Z

On Thu, Nov 08, 2018 at 10:26:38AM -0700, Jonathan Corbet wrote:
> On Mon, 5 Nov 2018 11:55:46 -0500
> Daniel Jordan <daniel.m.jordan@oracle.com> wrote:
>
> > Motivates and explains the ktask API for kernel clients.
>
> A couple of quick thoughts:
>
> - Agree with Peter on the use of "task"; something like "job" would be far
> less likely to create confusion. Maybe you could even call it a "batch
> job" to give us old-timers warm fuzzies...:)

smp_job? Or smp_batch, for that retro flavor? :)

>
> - You have kerneldoc comments for the API functions, but you don't pull
> those into the documentation itself. Adding some kernel-doc directives
> could help to fill things out nicely with little effort.

I thought this part of ktask.rst handled that, or am I not doing it right?

Interface
=========

.. kernel-doc:: include/linux/ktask.h

Thanks for the comments,
Daniel