renegade-project/linux-next
2
0
Fork 0
mirror of https://github.com/edk2-porting/linux-next.git synced 2024-12-17 01:34:00 +08:00
Code

devm-helpers: Fix devm_delayed_work_autocancel() kerneldoc

Browse Source 
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: 0341ce5443 ("workqueue: Add resource managed version of delayed work init")
Reviewed-by: Hans de Goede <hdegoede@redhat.com>
Signed-off-by: Matti Vaittinen <matti.vaittinen@fi.rohmeurope.com>
Link: https://lore.kernel.org/r/db3a8b4b8899fdf109a0cc760807de12d3b4f09b.1619028482.git.matti.vaittinen@fi.rohmeurope.com
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
This commit is contained in:
Matti Vaittinen 2021-04-21 21:11:32 +03:00 committed by Greg Kroah-Hartman
parent bd2a895f21
commit a943d76352
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
include/linux/devm-helpers.h
View File

@ -32,13 +32,14 @@ static inline void devm_delayed_work_drop(void *res)
}
/**
* devm_delayed_work_autocancel - Resource-managed work allocation
* @dev: Device which lifetime work is bound to
* @pdata: work to be cancelled when driver is detached
* devm_delayed_work_autocancel - Resource-managed delayed work allocation
* @dev: Device which lifetime work is bound to
* @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.
*/