docs/kobject: Explain device.groups
PATCH 1/1 docs/kobject: Explain device.groups
Many drivers use device_create_file() where device.groups should be used instead. Since this has not yet been documented, add a note in Documentation/kobject.txt that explains why device.groups should be used.
Signed-off-by Bart Van Assche <[email protected]>
Cc Greg Kroah-Hartman <[email protected]>
Cc Randy Dunlap <[email protected]>
--- Documentation/kobject.txt | 5 ++++- 1 files changed, 4 insertions(+), 1 deletions(-)
Documentation/kobject.txt +4 -1
@@ -171,7 +171,10 @@ call to kobject_uevent(): Use the KOBJ_ADD action for when the kobject is first added to the kernel. This should be done only after any attributes or children of the kobject have been initialized properly, as userspace will instantly start to look -for them when this call happens. +for them when this call happens. As an example, device attributes must be +created by initializing device.groups properly before calling +device_register() instead of calling device_create_file() after the device +has been registered. When the kobject is removed from the kernel (details on how to do that is below), the uevent for KOBJ_REMOVE will be automatically created by the
Signature · 1 line
1.7.3.4
Quoted 4 lines · Bart Van Assche
Many drivers use
device_create_file()where device.groups should be used instead. Since this has not yet been documented, add a note inDocumentation/kobject.txtthat explains why device.groups should be used.
That's a nice goal, but kobject.txt is now about the driver model interfaces. Care to put that in the driver model documentation instead?
thanks,
greg k-h