Re: [PATCH] Add kerneldoc for flush_scheduled_work()

Ingo Molnar
2009-08-12T10:51:37Z

* Peter Zijlstra <peterz@infradead.org> wrote:

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

Ah, the main changes i did were to the body, that is what
caught my eyes. If KernelDoc doesnt handle line-wrap in the
first line then that has to stay so. (and KernelDoc needs to
be fixed as well - it should result in better documentation,
not worse)

Ingo