powercap: make documentation reflect code
PATCH 1/1 powercap: make documentation reflect code
Fix up documentation of the struct members to reflect reality. Also fixup a stray whitespace.
Signed-off-by Amit Kucheria <[email protected]>
--- include/linux/powercap.h | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-)
include/linux/powercap.h +5 -6
@@ -44,19 +44,18 @@ struct powercap_control_type_ops { };/** -* struct powercap_control_type- Defines a powercap control_type -* @name: name of control_type +* struct powercap_control_type - Defines a powercap control_type * @dev: device for this control_type * @idr: idr to have unique id for its child -* @root_node: Root holding power zones for this control_type +* @nr_zones: counter for number of zones of this type * @ops: Pointer to callback struct -* @node_lock: mutex for control type +* @lock: mutex for control type * @allocated: This is possible that client owns the memory * used by this structure. In this case * this flag is set to false by framework to * prevent deallocation during release process. * Otherwise this flag is set to true. -* @ctrl_inst: link to the control_type list +* @node: linked-list node * * Defines powercap control_type. This acts as a container for power * zones, which use same method to control power. E.g. RAPL, RAPL-PCI etc.
@@ -129,7 +128,7 @@ struct powercap_zone_ops {* this flag is set to false by framework to * prevent deallocation during release process. * Otherwise this flag is set to true. -* @constraint_ptr: List of constraints for this zone. +* @constraints: List of constraints for this zone. * * This defines a power zone instance. The fields of this structure are * private, and should not be used by client drivers.
Signature · 1 line
2.25.1
Rafael J. Wysocki
maintainerQuoted 38 lines · Amit Kucheria
Fix up documentation of the struct members to reflect reality. Also fixup a stray whitespace.
Signed-off-by Amit Kucheria <[email protected]>--- include/linux/powercap.h | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-)include/linux/powercap.h +4
-5@@ -44,19 +44,18 @@ struct powercap_control_type_ops { };/** -* struct powercap_control_type- Defines a powercap control_type -* @name: name of control_type +* struct powercap_control_type - Defines a powercap control_type * @dev: device for this control_type * @idr: idr to have unique id for its child -* @root_node: Root holding power zones for this control_type +* @nr_zones: counter for number of zones of this type * @ops: Pointer to callback struct -* @node_lock: mutex for control type +* @lock: mutex for control type * @allocated: This is possible that client owns the memory * used by this structure. In this case * this flag is set to false by framework to * prevent deallocation during release process. * Otherwise this flag is set to true. -* @ctrl_inst: link to the control_type list +* @node: linked-list node * * Defines powercap control_type. This acts as a container for power * zones, which use same method to control power. E.g. RAPL, RAPL-PCI etc.
include/linux/powercap.h struct powercap_zone_ops {
Quoted 9 lines
include/linux/powercap.h +1
-2@@ -129,7 +128,7 @@ struct powercap_zone_ops {* this flag is set to false by framework to * prevent deallocation during release process. * Otherwise this flag is set to true. -* @constraint_ptr: List of constraints for this zone. +* @constraints: List of constraints for this zone. * * This defines a power zone instance. The fields of this structure are * private, and should not be used by client drivers. --
Applied with some changelog edits as 5.9-rc material, thanks!