diff options
| author | Mark Brown <broonie@opensource.wolfsonmicro.com> | 2012-05-03 18:15:12 +0100 |
|---|---|---|
| committer | Greg Kroah-Hartman <gregkh@linuxfoundation.org> | 2012-05-04 16:33:16 -0700 |
| commit | 698cd2ddd851b34e7200b4f846ae68306e11bae4 (patch) | |
| tree | 7c37c5e63eabacc6b863e671aacc57ed217159ce /drivers/base | |
| parent | 94758185689ee96694558d720d44e81b4e0abc3d (diff) | |
| download | linux-698cd2ddd851b34e7200b4f846ae68306e11bae4.tar.gz | |
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 <broonie@opensource.wolfsonmicro.com> Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Diffstat (limited to 'drivers/base')
| -rw-r--r-- | drivers/base/devres.c | 4 |
1 files changed, 4 insertions, 0 deletions
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. */ |