diff options
| author | Tobin C. Harding <tobin@kernel.org> | 2019-04-28 09:56:52 +1000 |
|---|---|---|
| committer | Greg Kroah-Hartman <gregkh@linuxfoundation.org> | 2019-04-28 18:16:03 +0200 |
| commit | 1fd7c3b438a2e4741435ed4d45546c03abf045b2 (patch) | |
| tree | 8e15a4600d61565b3495fe0040d49f3019371881 /lib/kobject.c | |
| parent | 92067f843854be0eef1e41ff00cb465247a83c42 (diff) | |
kobject: Improve doc clarity kobject_init_and_add()
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>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Diffstat (limited to 'lib/kobject.c')
| -rw-r--r-- | lib/kobject.c | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/lib/kobject.c b/lib/kobject.c index c97b5729f94d..a30ee0467942 100644 --- a/lib/kobject.c +++ b/lib/kobject.c @@ -450,9 +450,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, ...) |