From 698cd2ddd851b34e7200b4f846ae68306e11bae4 Mon Sep 17 00:00:00 2001 From: Mark Brown Date: Thu, 3 May 2012 18:15:12 +0100 Subject: devres: Clarify documentation for devres_destroy() It's not massively obvious (at least to me) that removing and freeing a resource does not involve calling the release function for the resource but rather only removes the management of it. Make the documentation more explicit. Signed-off-by: Mark Brown Signed-off-by: Greg Kroah-Hartman --- drivers/base/devres.c | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'drivers/base/devres.c') diff --git a/drivers/base/devres.c b/drivers/base/devres.c index 524bf96c289f..1741a60de117 100644 --- a/drivers/base/devres.c +++ b/drivers/base/devres.c @@ -309,6 +309,10 @@ EXPORT_SYMBOL_GPL(devres_remove); * which @match returns 1. If @match is NULL, it's considered to * match all. If found, the resource is removed atomically and freed. * + * Note that the release function for the resource will not be called, + * only the devres-allocated data will be freed. The caller becomes + * responsible for freeing any other data. + * * RETURNS: * 0 if devres is found and freed, -ENOENT if not found. */ -- cgit v1.2.3-59-g8ed1b