diff options
| author |   Greg Kroah-Hartman <gregkh@linuxfoundation.org> | 2019-05-02 12:22:24 +0200 |
|---|---|---|
| committer | Greg Kroah-Hartman <gregkh@linuxfoundation.org> | 2019-05-03 08:26:51 +0200 |
| commit | 70e16a620e075cb916644e06012766639b58b2fb (patch) | |
| tree | a2a0b7b2a61d990148b832b653f5f4801efefddb /lib | |
| parent | kobject: Fix kernel-doc comment first line (diff) | |
| download | linux-dev-70e16a620e075cb916644e06012766639b58b2fb.tar.xz linux-dev-70e16a620e075cb916644e06012766639b58b2fb.zip | |
kobject: clean up the kobject add documentation a bit more
Commit 1fd7c3b438a2 ("kobject: Improve doc clarity kobject_init_and_add()")
tried to provide more clarity, but the reference to kobject_del() was
incorrect. Fix that up by removing that line, and hopefully be more explicit
as to exactly what needs to happen here once you register a kobject with the
kobject core.
Acked-by: Tobin C. Harding <tobin@kernel.org>
Fixes: 1fd7c3b438a2 ("kobject: Improve doc clarity kobject_init_and_add()")
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Diffstat (limited to 'lib')
| -rw-r--r-- | lib/kobject.c | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/lib/kobject.c b/lib/kobject.c index 3f4b7e95b0c2..f2ccdbac8ed9 100644 --- a/lib/kobject.c +++ b/lib/kobject.c @@ -416,8 +416,12 @@ static __printf(3, 0) int kobject_add_varg(struct kobject *kobj, * to this function be directly freed with a call to kfree(), * that can leak memory. * - * If this call returns successfully and you later need to unwind - * kobject_add() for the error path you should call kobject_del(). + * If this function returns success, kobject_put() must also be called + * in order to properly clean up the memory associated with the object. + * + * In short, once this function is called, kobject_put() MUST be called + * when the use of the object is finished in order to properly free + * everything. */ int kobject_add(struct kobject *kobj, struct kobject *parent, const char *fmt, ...) |