Messages in this thread Patch in this message | | | Date | Wed, 21 Apr 2021 21:11:32 +0300 | From | Matti Vaittinen <> | Subject | [PATCHi RESEND] 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: 0341ce544394 ("workqueue: Add resource managed version of delayed work init") Signed-off-by: Matti Vaittinen <matti.vaittinen@fi.rohmeurope.com> Reviewed-by: Hans de Goede <hdegoede@redhat.com> --- Sorry for the resend folks. I did accidentally send this first time off-list. Luckily Greg spotted that. So, resending with proper recipients - no other changes.
include/linux/devm-helpers.h | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-)
diff --git a/include/linux/devm-helpers.h b/include/linux/devm-helpers.h index f64e0c9f3763..f40f77717a24 100644 --- a/include/linux/devm-helpers.h +++ b/include/linux/devm-helpers.h @@ -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. */ base-commit: bd2a895f21eb9195a42e52e5f451dccc854cc71d -- 2.25.4
-- Matti Vaittinen, Linux device drivers ROHM Semiconductors, Finland SWDC Kiviharjunlenkki 1E 90220 OULU FINLAND
~~~ "I don't think so," said Rene Descartes. Just then he vanished ~~~ Simon says - in Latin please. ~~~ "non cogito me" dixit Rene Descarte, deinde evanescavit ~~~ Thanks to Simon Glass for the translation =]
| |