Re: [PATCH] Add kerneldoc for flush_scheduled_work()

James Bottomley
2009-08-12T16:22:08Z

On Wed, 2009-08-12 at 10:13 -0400, Alan Stern wrote:
> On Wed, 12 Aug 2009, Ingo Molnar wrote:
>
> > > And here I was thinking kerneldoc doesn't actually work
> > > like that, but perhaps Randy fixed it so the initial
> > > description can line-wrap?
>
> Yes, that's what I thought too. If kerneldoc has been fixed then the
> description line certainly should get wrapped.

I really don't think it needs to be fixed: it's a feature not a bug. It
requires people writing kernel doc actually to think of one line
summaries.

LSI recently tried to submit a ten line wrapped summary which the
current feature makes it very easy to knock back and say this must be a
single line, so trim it and move the rest to the function description
body.

James