[PATCH 72/75] kset: add some kerneldoc to help describe what these strange things are

Previous message: [thread] [date] [author]
Next message: [thread] [date] [author]
From: Greg Kroah-Hartman
Date: Friday, October 12, 2007 - 3:17 pm

Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
---
 include/linux/kobject.h |   33 +++++++++++++++++----------------
 1 files changed, 17 insertions(+), 16 deletions(-)

diff --git a/include/linux/kobject.h b/include/linux/kobject.h
index 05cc5b2..973aa7b 100644
--- a/include/linux/kobject.h
+++ b/include/linux/kobject.h
@@ -117,29 +117,30 @@ struct kset_uevent_ops {
 		      struct kobj_uevent_env *env);
 };
 
-/*
- *	struct kset - a set of kobjects of a specific type, belonging
- *	to a specific subsystem.
- *
- *	All kobjects of a kset should be embedded in an identical 
- *	type. This type may have a descriptor, which the kset points
- *	to. This allows there to exist sets of objects of the same
- *	type in different subsystems.
+/**
+ * struct kset - a set of kobjects of a specific type, belonging to a specific subsystem.
  *
- *	A subsystem does not have to be a list of only one type 
- *	of object; multiple ksets can belong to one subsystem. All 
- *	ksets of a subsystem share the subsystem's lock.
+ * A kset defines a group of kobjects.  They can be individually
+ * different "types" but overall these kobjects all want to be grouped
+ * together and operated on in the same manner.  ksets are used to
+ * define the attribute callbacks and other common events that happen to
+ * a kobject.
  *
- *	Each kset can support specific event variables; it can
- *	supress the event generation or add subsystem specific
- *	variables carried with the event.
+ * @ktype: the struct kobj_type for this specific kset
+ * @list: the list of all kobjects for this kset
+ * @list_lock: a lock for iterating over the kobjects
+ * @kobj: the embedded kobject for this kset (recursion, isn't it fun...)
+ * @uevent_ops: the set of uevent operations for this kset.  These are
+ * called whenever a kobject has something happen to it so that the kset
+ * can add new environment variables, or filter out the uevents if so
+ * desired.
  */
 struct kset {
-	struct kobj_type	* ktype;
+	struct kobj_type	*ktype;
 	struct list_head	list;
 	spinlock_t		list_lock;
 	struct kobject		kobj;
-	struct kset_uevent_ops	* uevent_ops;
+	struct kset_uevent_ops	*uevent_ops;
 };
 
 
-- 
1.5.3.4

-
Previous message: [thread] [date] [author]
Next message: [thread] [date] [author]

Messages in current thread:
[PATCH 02/75] HOWTO: update ja_JP/HOWTO with latest changes, Greg Kroah-Hartman, (Fri Oct 12, 3:16 pm)
[PATCH 03/75] Driver core: make sysfs uevent-attributes static, Greg Kroah-Hartman, (Fri Oct 12, 3:16 pm)
[PATCH 04/75] Driver core: change add_uevent_var to use a ..., Greg Kroah-Hartman, (Fri Oct 12, 3:16 pm)
[PATCH 05/75] Driver core: add CONFIG_UEVENT_HELPER_PATH, Greg Kroah-Hartman, (Fri Oct 12, 3:16 pm)
[PATCH 06/75] Driver core: remove subsys_set_kset, Greg Kroah-Hartman, (Fri Oct 12, 3:16 pm)
[PATCH 07/75] Driver core: remove kset_set_kset_s, Greg Kroah-Hartman, (Fri Oct 12, 3:16 pm)
[PATCH 08/75] Driver core: remove subsys_put(), Greg Kroah-Hartman, (Fri Oct 12, 3:16 pm)
[PATCH 09/75] Driver core: remove subsys_get(), Greg Kroah-Hartman, (Fri Oct 12, 3:16 pm)
[PATCH 10/75] Driver core: remove put_bus(), Greg Kroah-Hartman, (Fri Oct 12, 3:16 pm)
[PATCH 11/75] Driver core: remove get_bus(), Greg Kroah-Hartman, (Fri Oct 12, 3:16 pm)
[PATCH 12/75] kobjects: fix up improper use of the kobject ..., Greg Kroah-Hartman, (Fri Oct 12, 3:16 pm)
[PATCH 13/75] cdev: remove unneeded setting of cdev names, Greg Kroah-Hartman, (Fri Oct 12, 3:16 pm)
[PATCH 14/75] Drivers: clean up direct setting of the name ..., Greg Kroah-Hartman, (Fri Oct 12, 3:16 pm)
[PATCH 15/75] kobject: remove the static array for the name, Greg Kroah-Hartman, (Fri Oct 12, 3:16 pm)
[PATCH 16/75] Driver core: clean up removed functions from ..., Greg Kroah-Hartman, (Fri Oct 12, 3:16 pm)
[PATCH 17/75] debugfs: helper for decimal challenged, Greg Kroah-Hartman, (Fri Oct 12, 3:16 pm)
[PATCH 18/75] sysfs/file.c - use mutex instead of semaphore, Greg Kroah-Hartman, (Fri Oct 12, 3:16 pm)
[PATCH 19/75] sysfs: cleanup semaphore.h, Greg Kroah-Hartman, (Fri Oct 12, 3:16 pm)
[PATCH 20/75] sysfs: Remove first pass at shadow directory ..., Greg Kroah-Hartman, (Fri Oct 12, 3:16 pm)
[PATCH 21/75] sysfs: cosmetic changes in sysfs_lookup(), Greg Kroah-Hartman, (Fri Oct 12, 3:16 pm)
[PATCH 22/75] sysfs: simplify sysfs_rename_dir(), Greg Kroah-Hartman, (Fri Oct 12, 3:16 pm)
[PATCH 23/75] sysfs: make sysfs_add/remove_one() call link ..., Greg Kroah-Hartman, (Fri Oct 12, 3:16 pm)
[PATCH 24/75] sysfs: make sysfs_add_one() automatically ch ..., Greg Kroah-Hartman, (Fri Oct 12, 3:16 pm)
[PATCH 25/75] sysfs: make sysfs_addrm_finish() return void, Greg Kroah-Hartman, (Fri Oct 12, 3:16 pm)
[PATCH 26/75] dmi-id: Use dynamic sysfs attributes, Greg Kroah-Hartman, (Fri Oct 12, 3:16 pm)
[PATCH 27/75] dmi-id: Possible cleanup, Greg Kroah-Hartman, (Fri Oct 12, 3:16 pm)
[PATCH 28/75] Convert from class_device to device for driv ..., Greg Kroah-Hartman, (Fri Oct 12, 3:16 pm)
[PATCH 29/75] Convert from class_device to device in drive ..., Greg Kroah-Hartman, (Fri Oct 12, 3:16 pm)
[PATCH 30/75] Driver core: exclude kobject_uevent.c for !C ..., Greg Kroah-Hartman, (Fri Oct 12, 3:16 pm)
[PATCH 31/75] Driver core: add uevent file for bus and driver, Greg Kroah-Hartman, (Fri Oct 12, 3:16 pm)
[PATCH 32/75] Driver core: kerneldoc - kobject_uevent_env ..., Greg Kroah-Hartman, (Fri Oct 12, 3:16 pm)
[PATCH 33/75] Fix Firmware class name collision, Greg Kroah-Hartman, (Fri Oct 12, 3:16 pm)
[PATCH 34/75] drivers/base/power/: make 2 functions static, Greg Kroah-Hartman, (Fri Oct 12, 3:16 pm)
[PATCH 35/75] sysfs: Fix typos in fs/sysfs/file.c, Greg Kroah-Hartman, (Fri Oct 12, 3:16 pm)
[PATCH 36/75] sysdev: remove global sysdev drivers list, Greg Kroah-Hartman, (Fri Oct 12, 3:16 pm)
[PATCH 37/75] Driver core: Make platform_device.id an int, Greg Kroah-Hartman, (Fri Oct 12, 3:16 pm)
[PATCH 38/75] sysfs: fix i_mutex locking in sysfs_get_dentry(), Greg Kroah-Hartman, (Fri Oct 12, 3:16 pm)
[PATCH 39/75] sysfs: Move all of inode initialization into ..., Greg Kroah-Hartman, (Fri Oct 12, 3:16 pm)
[PATCH 40/75] sysfs: Remove sysfs_instantiate, Greg Kroah-Hartman, (Fri Oct 12, 3:16 pm)
[PATCH 41/75] sysfs: Use kill_anon_super, Greg Kroah-Hartman, (Fri Oct 12, 3:16 pm)
[PATCH 42/75] sysfs: Make sysfs_mount static, Greg Kroah-Hartman, (Fri Oct 12, 3:16 pm)
[PATCH 43/75] sysfs: In sysfs_lookup don't open code sysfs ..., Greg Kroah-Hartman, (Fri Oct 12, 3:16 pm)
[PATCH 44/75] sysfs: Simplify readdir., Greg Kroah-Hartman, (Fri Oct 12, 3:16 pm)
[PATCH 45/75] sysfs: Rewrite sysfs_drop_dentry., Greg Kroah-Hartman, (Fri Oct 12, 3:16 pm)
[PATCH 46/75] sysfs: Introduce sysfs_rename_mutex, Greg Kroah-Hartman, (Fri Oct 12, 3:16 pm)
[PATCH 47/75] sysfs: simply sysfs_get_dentry, Greg Kroah-Hartman, (Fri Oct 12, 3:16 pm)
[PATCH 48/75] sysfs: Remove s_dentry, Greg Kroah-Hartman, (Fri Oct 12, 3:16 pm)
[PATCH 49/75] sysfs: Rewrite rename in terms of sysfs dirents, Greg Kroah-Hartman, (Fri Oct 12, 3:16 pm)
[PATCH 50/75] sysfs: Rewrite sysfs_move_dir in terms of sy ..., Greg Kroah-Hartman, (Fri Oct 12, 3:16 pm)
[PATCH 51/75] PTY: add kernel parameter to overwrite legac ..., Greg Kroah-Hartman, (Fri Oct 12, 3:16 pm)
[PATCH 52/75] sysfs: spit a warning to users when they try ..., Greg Kroah-Hartman, (Fri Oct 12, 3:16 pm)
[PATCH 53/75] sysfs: fix comments of sysfs_add/remove_one(), Greg Kroah-Hartman, (Fri Oct 12, 3:16 pm)
[PATCH 54/75] sysfs: fix sysfs_chmod_file() such that it u ..., Greg Kroah-Hartman, (Fri Oct 12, 3:16 pm)
[PATCH 55/75] sysfs: clean up header files, Greg Kroah-Hartman, (Fri Oct 12, 3:16 pm)
[PATCH 56/75] sysfs: kill sysfs_update_file(), Greg Kroah-Hartman, (Fri Oct 12, 3:17 pm)
[PATCH 57/75] sysfs: reposition sysfs_dirent-&gt;s_mode., Greg Kroah-Hartman, (Fri Oct 12, 3:17 pm)
[PATCH 58/75] sysfs: kill unnecessary sysfs_get() in open ..., Greg Kroah-Hartman, (Fri Oct 12, 3:17 pm)
[PATCH 59/75] sysfs: kill unnecessary NULL pointer check i ..., Greg Kroah-Hartman, (Fri Oct 12, 3:17 pm)
[PATCH 60/75] sysfs: make bin attr open get active referen ..., Greg Kroah-Hartman, (Fri Oct 12, 3:17 pm)
[PATCH 61/75] sysfs: make s_elem an anonymous union, Greg Kroah-Hartman, (Fri Oct 12, 3:17 pm)
[PATCH 62/75] sysfs: open code sysfs_attach_dentry(), Greg Kroah-Hartman, (Fri Oct 12, 3:17 pm)
[PATCH 63/75] sysfs: make sysfs_root a regular directory d ..., Greg Kroah-Hartman, (Fri Oct 12, 3:17 pm)
[PATCH 65/75] sysfs: implement sysfs_open_dirent, Greg Kroah-Hartman, (Fri Oct 12, 3:17 pm)
[PATCH 66/75] sysfs: move sysfs file poll implementation t ..., Greg Kroah-Hartman, (Fri Oct 12, 3:17 pm)
[PATCH 67/75] driver core: remove subsystem_init(), Greg Kroah-Hartman, (Fri Oct 12, 3:17 pm)
[PATCH 68/75] Driver core: rename ktype_class, Greg Kroah-Hartman, (Fri Oct 12, 3:17 pm)
[PATCH 69/75] Driver core: rename ktype_device, Greg Kroah-Hartman, (Fri Oct 12, 3:17 pm)
[PATCH 70/75] Driver core: rename ktype_driver, Greg Kroah-Hartman, (Fri Oct 12, 3:17 pm)
[PATCH 71/75] Driver core: rename ktype_edd and ktype_efivar, Greg Kroah-Hartman, (Fri Oct 12, 3:17 pm)
[PATCH 72/75] kset: add some kerneldoc to help describe wh ..., Greg Kroah-Hartman, (Fri Oct 12, 3:17 pm)
[PATCH 73/75] kobject: update the copyrights, Greg Kroah-Hartman, (Fri Oct 12, 3:17 pm)
[PATCH 74/75] sysfs: add copyrights, Greg Kroah-Hartman, (Fri Oct 12, 3:17 pm)
[PATCH 75/75] PM: merge device power-management source files, Greg Kroah-Hartman, (Fri Oct 12, 3:17 pm)