Skip to contentSkip to conversation

Add kerneldoc for flush_scheduled_work()

PATCH Randy Dunlap 1 participant 1 message Aug 12, 2009

lore
Share & tools
lore
#0 lore raw

From: [email protected]

Quoted 16 lines · Ingo Molnar
Quoted 10 lines · Alan Stern

This patch (as1279) adds kerneldoc for flush_scheduled_work() containing a stern warning that the function should be avoided.

+/**
+ * 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:

Quoted 6 lines

/**
* 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