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

From: Jonathan Corbet
Date: Thu Nov 08 2018 - 12:26:42 EST


On Mon, 5 Nov 2018 11:55:46 -0500
Daniel Jordan <daniel.m.jordan@xxxxxxxxxx> 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...:)

- 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.

Thanks,

jon