From: Mark Brown <broonie@opensource.wolfsonmicro.com>
Date: Thu, 3 May 2012 17:15:12 +0000 (+0100)
Subject: devres: Clarify documentation for devres_destroy()
X-Git-Url: https://git.karo-electronics.de/?a=commitdiff_plain;h=698cd2ddd851b34e7200b4f846ae68306e11bae4;p=linux-beck.git

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>
---

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.
  */