Commit f3b53687 authored by Randy Dunlap's avatar Randy Dunlap Committed by Rafael J. Wysocki
Browse files

powercap: correct kernel-doc function parameter names 



Use the correct function parameter names in kernel-doc comments to
avoid these warnings:

Warning: include/linux/powercap.h:254 function parameter 'name' not
 described in 'powercap_register_control_type'
Warning: include/linux/powercap.h:298 function parameter 'nr_constraints'
 not described in 'powercap_register_zone'

Signed-off-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Link: https://patch.msgid.link/20260312051444.685136-1-rdunlap@infradead.org


Signed-off-by: default avatarRafael J. Wysocki <rafael.j.wysocki@intel.com>
parent f82fabe1

include/linux/powercap.h

+2 −2
Original line number Diff line number Diff line
@@ -238,7 +238,7 @@ static inline void *powercap_get_zone_data(struct powercap_zone *power_zone) 
*			Advantage of this parameter is that client can embed

*			this data in its data structures and allocate in a

*			single call, preventing multiple allocations.

* @control_type_name:	The Name of this control_type, which will be shown

* @name:		The Name of this control_type, which will be shown

*			in the sysfs Interface.

* @ops:			Callbacks for control type. This parameter is optional.

*
@@ -277,7 +277,7 @@ int powercap_unregister_control_type(struct powercap_control_type *instance); 
* @name:	A name for this zone.

* @parent:	A pointer to the parent power zone instance if any or NULL

* @ops:		Pointer to zone operation callback structure.

* @no_constraints: Number of constraints for this zone

* @nr_constraints: Number of constraints for this zone

* @const_ops:	Pointer to constraint callback structure

*

* Register a power zone under a given control type. A power zone must register