Commit a943d763 authored by Matti Vaittinen's avatar Matti Vaittinen Committed by Greg Kroah-Hartman
Browse files

devm-helpers: Fix devm_delayed_work_autocancel() kerneldoc 



The kerneldoc for devm_delayed_work_autocancel() contains invalid
parameter description.

Fix the parameter description. And while at it - make it more obvous that
this function operates on delayed_work. That helps differentiating with
resource-managed INIT_WORK description (which should follow in near future)

Fixes: 0341ce54 ("workqueue: Add resource managed version of delayed work init")
Reviewed-by: default avatarHans de Goede <hdegoede@redhat.com>
Signed-off-by: default avatarMatti Vaittinen <matti.vaittinen@fi.rohmeurope.com>
Link: https://lore.kernel.org/r/db3a8b4b8899fdf109a0cc760807de12d3b4f09b.1619028482.git.matti.vaittinen@fi.rohmeurope.com


Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent bd2a895f

include/linux/devm-helpers.h

+7 −6
Original line number Diff line number Diff line
@@ -32,13 +32,14 @@ static inline void devm_delayed_work_drop(void *res) 
}



/**

 * devm_delayed_work_autocancel - Resource-managed work allocation

 * devm_delayed_work_autocancel - Resource-managed delayed work allocation

 * @dev:	Device which lifetime work is bound to

 * @pdata: work to be cancelled when driver is detached

 * @w:		Work item to be queued

 * @worker:	Worker function

 *

 * Initialize work which is automatically cancelled when driver is detached.

 * A few drivers need delayed work which must be cancelled before driver

 * is detached to avoid accessing removed resources.

 * Initialize delayed work which is automatically cancelled when driver is

 * detached. A few drivers need delayed work which must be cancelled before

 * driver is detached to avoid accessing removed resources.

 * devm_delayed_work_autocancel() can be used to omit the explicit

 * cancelleation when driver is detached.

 */