aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGreg Kroah-Hartman <gregkh@suse.de>2007-12-04 14:45:47 +0800
committerGreg Kroah-Hartman <gregkh@suse.de>2007-12-17 10:33:18 -0800
commit8c4606b1a4f6eb09344294b7f11641f36cd402af (patch)
treeb685455b7b7a1344e44fa93b9c6e6320619e3c51
parentda8cadb31b82c9d41fc593c8deab6aa20b162d6b (diff)
kobject: fix the documentation of how kobject_set_name works
Thanks to Dave Young <hidave.darkstar@gmail.com> for pointing out that I forgot to update the comment when I rewrote kobject_set_name. Cc: Dave Young <hidave.darkstar@gmail.com> Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
-rw-r--r--lib/kobject.c12
1 files changed, 6 insertions, 6 deletions
diff --git a/lib/kobject.c b/lib/kobject.c
index b52e9f4ef37..3590f022a60 100644
--- a/lib/kobject.c
+++ b/lib/kobject.c
@@ -234,13 +234,13 @@ int kobject_register(struct kobject * kobj)
/**
- * kobject_set_name - Set the name of an object
- * @kobj: object.
- * @fmt: format string used to build the name
+ * kobject_set_name - Set the name of a kobject
+ * @kobj: kobject to name
+ * @fmt: format string used to build the name
*
- * If strlen(name) >= KOBJ_NAME_LEN, then use a dynamically allocated
- * string that @kobj->k_name points to. Otherwise, use the static
- * @kobj->name array.
+ * This sets the name of the kobject. If you have already added the
+ * kobject to the system, you must call kobject_rename() in order to
+ * change the name of the kobject.
*/
int kobject_set_name(struct kobject * kobj, const char * fmt, ...)
{