Browse Source

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>
Mark Brown 13 years ago
parent
commit
698cd2ddd8
1 changed files with 4 additions and 0 deletions
  1. 4 0
      drivers/base/devres.c

+ 4 - 0
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
  * which @match returns 1.  If @match is NULL, it's considered to
  * match all.  If found, the resource is removed atomically and freed.
  * 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:
  * RETURNS:
  * 0 if devres is found and freed, -ENOENT if not found.
  * 0 if devres is found and freed, -ENOENT if not found.
  */
  */