Re: [PATCH 1/3] devres: Clarify documentation for devres_destroy()

[Grant Likely <grant.likely@secretlab.ca>]

On Thu,  3 May 2012 18:15:12 +0100, Mark Brown <broonie@opensource.wolfsonmicro.com> wrote:
> 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>

This series looks appropriate to me.  FWIW:

Acked-by: Grant Likely <grant.likely@secretlab.ca>

> ---
>  drivers/base/devres.c |    4 ++++
>  1 file changed, 4 insertions(+)
> 
> diff --git a/drivers/base/devres.c b/drivers/base/devres.c
> index 524bf96..1741a60 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.
>   */
> -- 
> 1.7.10
> 

-- 
Grant Likely, B.Sc, P.Eng.
Secret Lab Technologies, Ltd.