]> git.ipfire.org Git - thirdparty/kernel/linux.git/commitdiff
powercap: correct kernel-doc function parameter names
authorRandy Dunlap <rdunlap@infradead.org>
Thu, 12 Mar 2026 05:14:44 +0000 (22:14 -0700)
committerRafael J. Wysocki <rafael.j.wysocki@intel.com>
Mon, 30 Mar 2026 11:57:49 +0000 (13:57 +0200)
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: Randy Dunlap <rdunlap@infradead.org>
Link: https://patch.msgid.link/20260312051444.685136-1-rdunlap@infradead.org
Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
include/linux/powercap.h

index 3d557bbcd2c712176e774b2a6d9f8c513c9fa950..603419db924ca8d65a17f6f621f17e2d7ac1ac11 100644 (file)
@@ -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