[PATCH] kobject: Improve doc clarity kobject_init_and_add()

[PATCH] kobject: Improve doc clarity kobject_init_and_add()

[Tobin C. Harding]

Function kobject_init_and_add() is currently misused in a number of
places in the kernel.  On error return kobject_put() must be called but
is at times not.

Make the function documentation more explicit about calling
kobject_put() in the error path.

Signed-off-by: Tobin C. Harding <tobin@kernel.org>
---
 lib/kobject.c | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

diff --git a/lib/kobject.c b/lib/kobject.c
index aa89edcd2b63..58d1d7a64203 100644
--- a/lib/kobject.c
+++ b/lib/kobject.c
@@ -437,9 +437,12 @@ EXPORT_SYMBOL(kobject_add);
  * @parent: pointer to the parent of this kobject.
  * @fmt: the name of the kobject.
  *
- * This function combines the call to kobject_init() and
- * kobject_add().  The same type of error handling after a call to
- * kobject_add() and kobject lifetime rules are the same here.
+ * This function combines the call to kobject_init() and kobject_add().
+ *
+ * If this function returns an error, kobject_put() must be called to
+ * properly clean up the memory associated with the object.  This is the
+ * same type of error handling after a call to kobject_add() and kobject
+ * lifetime rules are the same here.
  */
 int kobject_init_and_add(struct kobject *kobj, struct kobj_type *ktype,
 			 struct kobject *parent, const char *fmt, ...)
-- 
2.21.0

Re: [PATCH] kobject: Improve doc clarity kobject_init_and_add()

[Rafael J. Wysocki]

On Sun, Apr 28, 2019 at 1:57 AM Tobin C. Harding <tobin@kernel.org> wrote:
>
> Function kobject_init_and_add() is currently misused in a number of
> places in the kernel.  On error return kobject_put() must be called but
> is at times not.
>
> Make the function documentation more explicit about calling
> kobject_put() in the error path.
>
> Signed-off-by: Tobin C. Harding <tobin@kernel.org>

Reviewed-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>

> ---
>  lib/kobject.c | 9 ++++++---
>  1 file changed, 6 insertions(+), 3 deletions(-)
>
> diff --git a/lib/kobject.c b/lib/kobject.c
> index aa89edcd2b63..58d1d7a64203 100644
> --- a/lib/kobject.c
> +++ b/lib/kobject.c
> @@ -437,9 +437,12 @@ EXPORT_SYMBOL(kobject_add);
>   * @parent: pointer to the parent of this kobject.
>   * @fmt: the name of the kobject.
>   *
> - * This function combines the call to kobject_init() and
> - * kobject_add().  The same type of error handling after a call to
> - * kobject_add() and kobject lifetime rules are the same here.
> + * This function combines the call to kobject_init() and kobject_add().
> + *
> + * If this function returns an error, kobject_put() must be called to
> + * properly clean up the memory associated with the object.  This is the
> + * same type of error handling after a call to kobject_add() and kobject
> + * lifetime rules are the same here.
>   */
>  int kobject_init_and_add(struct kobject *kobj, struct kobj_type *ktype,
>                          struct kobject *parent, const char *fmt, ...)
> --
> 2.21.0
>