Re: [PATCH] Add kerneldoc for flush_scheduled_work()

Randy Dunlap
2009-08-12T18:15:22Z

From: peterz@infradead.org

On Wed, 2009-08-12 at 11:41 +0200, Ingo Molnar wrote:
> * Alan Stern <stern@rowland.harvard.edu> wrote:
>
> > This patch (as1279) adds kerneldoc for flush_scheduled_work()
> > containing a stern warning that the function should be avoided.
> >
> > Signed-off-by: Alan Stern <stern@rowland.harvard.edu>

> >
> > +/**
> > + * flush_scheduled_work - ensure that all work scheduled on keventd_wq has run to completion.

> > + */
>
> Looks good - a small nit: please use proper/consistent line length,
> something like:
>
> /**
> * flush_scheduled_work - ensure that all work scheduled on
> * keventd_wq has run to completion
> *

> */

| And here I was thinking kerneldoc doesn't actually work like that, but
| perhaps Randy fixed it so the initial description can line-wrap?

Nope, function short description is still just a one-liner.

~Randy