[PATCH] thermal: core: thermal_core.h: fix all kernel-doc warnings

Randy Dunlap posted 1 patch 1 week, 2 days ago
drivers/thermal/thermal_core.h |    7 +++++--
1 file changed, 5 insertions(+), 2 deletions(-)
[PATCH] thermal: core: thermal_core.h: fix all kernel-doc warnings
Posted by Randy Dunlap 1 week, 2 days ago
Resolve all kernel-doc warnings in thermal_core.h:

Warning: drivers/thermal/thermal_core.h:99 bad line: trip point.
Warning: drivers/thermal/thermal_core.h:101 bad line: passive trip point.
Warning: drivers/thermal/thermal_core.h:152 struct member 'trips_attribute_group' not described in 'thermal_zone_device'
Warning: drivers/thermal/thermal_core.h:152 struct member 'debugfs' not described in 'thermal_zone_device'
Warning: drivers/thermal/thermal_core.h:152 struct member 'user_thresholds' not described in 'thermal_zone_device'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Rafael J. Wysocki <rafael@kernel.org>
Cc: Daniel Lezcano <daniel.lezcano@linaro.org>
Cc: Zhang Rui <rui.zhang@intel.com>
Cc: Lukasz Luba <lukasz.luba@arm.com>
Cc: linux-pm@vger.kernel.org

 drivers/thermal/thermal_core.h |    7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

--- linux-next-20260126.orig/drivers/thermal/thermal_core.h
+++ linux-next-20260126/drivers/thermal/thermal_core.h
@@ -77,6 +77,7 @@ struct thermal_governor {
  * @device:	&struct device for this thermal zone
  * @removal:	removal completion
  * @resume:	resume completion
+ * @trips_attribute_group: trip point sysfs attributes
  * @trips_high:	trips above the current zone temperature
  * @trips_reached:	trips below or at the current zone temperature
  * @trips_invalid:	trips with invalid temperature
@@ -97,9 +98,9 @@ struct thermal_governor {
  * @emul_temperature:	emulated temperature when using CONFIG_THERMAL_EMULATION
  * @passive:		1 if you've crossed a passive trip point, 0 otherwise.
  * @prev_low_trip:	the low current temperature if you've crossed a passive
-			trip point.
+ *			trip point.
  * @prev_high_trip:	the above current temperature if you've crossed a
-			passive trip point.
+ *			passive trip point.
  * @ops:	operations this &thermal_zone_device supports
  * @tzp:	thermal zone parameters
  * @governor:	pointer to the governor for this thermal zone
@@ -111,6 +112,8 @@ struct thermal_governor {
  * @poll_queue:	delayed work for polling
  * @notify_event: Last notification event
  * @state: 	current state of the thermal zone
+ * @debugfs:	this thermal zone device's thermal zone debug info
+ * @user_thresholds: list of userspace thresholds for temp. limit notifications
  * @trips:	array of struct thermal_trip objects
  */
 struct thermal_zone_device {
Re: [PATCH] thermal: core: thermal_core.h: fix all kernel-doc warnings
Posted by Lukasz Luba 1 week, 2 days ago

On 1/28/26 06:24, Randy Dunlap wrote:
> Resolve all kernel-doc warnings in thermal_core.h:
> 
> Warning: drivers/thermal/thermal_core.h:99 bad line: trip point.
> Warning: drivers/thermal/thermal_core.h:101 bad line: passive trip point.
> Warning: drivers/thermal/thermal_core.h:152 struct member 'trips_attribute_group' not described in 'thermal_zone_device'
> Warning: drivers/thermal/thermal_core.h:152 struct member 'debugfs' not described in 'thermal_zone_device'
> Warning: drivers/thermal/thermal_core.h:152 struct member 'user_thresholds' not described in 'thermal_zone_device'
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> ---
> Cc: Rafael J. Wysocki <rafael@kernel.org>
> Cc: Daniel Lezcano <daniel.lezcano@linaro.org>
> Cc: Zhang Rui <rui.zhang@intel.com>
> Cc: Lukasz Luba <lukasz.luba@arm.com>
> Cc: linux-pm@vger.kernel.org
> 
>   drivers/thermal/thermal_core.h |    7 +++++--
>   1 file changed, 5 insertions(+), 2 deletions(-)
> 
> --- linux-next-20260126.orig/drivers/thermal/thermal_core.h
> +++ linux-next-20260126/drivers/thermal/thermal_core.h
> @@ -77,6 +77,7 @@ struct thermal_governor {
>    * @device:	&struct device for this thermal zone
>    * @removal:	removal completion
>    * @resume:	resume completion
> + * @trips_attribute_group: trip point sysfs attributes
>    * @trips_high:	trips above the current zone temperature
>    * @trips_reached:	trips below or at the current zone temperature
>    * @trips_invalid:	trips with invalid temperature
> @@ -97,9 +98,9 @@ struct thermal_governor {
>    * @emul_temperature:	emulated temperature when using CONFIG_THERMAL_EMULATION
>    * @passive:		1 if you've crossed a passive trip point, 0 otherwise.
>    * @prev_low_trip:	the low current temperature if you've crossed a passive
> -			trip point.
> + *			trip point.
>    * @prev_high_trip:	the above current temperature if you've crossed a
> -			passive trip point.
> + *			passive trip point.
>    * @ops:	operations this &thermal_zone_device supports
>    * @tzp:	thermal zone parameters
>    * @governor:	pointer to the governor for this thermal zone
> @@ -111,6 +112,8 @@ struct thermal_governor {
>    * @poll_queue:	delayed work for polling
>    * @notify_event: Last notification event
>    * @state: 	current state of the thermal zone
> + * @debugfs:	this thermal zone device's thermal zone debug info
> + * @user_thresholds: list of userspace thresholds for temp. limit notifications
>    * @trips:	array of struct thermal_trip objects
>    */
>   struct thermal_zone_device {


Reviewed-by: Lukasz Luba <lukasz.luba@arm.com>
Re: [PATCH] thermal: core: thermal_core.h: fix all kernel-doc warnings
Posted by Rafael J. Wysocki 1 week, 2 days ago
On Wed, Jan 28, 2026 at 11:09 AM Lukasz Luba <lukasz.luba@arm.com> wrote:
>
>
>
> On 1/28/26 06:24, Randy Dunlap wrote:
> > Resolve all kernel-doc warnings in thermal_core.h:
> >
> > Warning: drivers/thermal/thermal_core.h:99 bad line: trip point.
> > Warning: drivers/thermal/thermal_core.h:101 bad line: passive trip point.
> > Warning: drivers/thermal/thermal_core.h:152 struct member 'trips_attribute_group' not described in 'thermal_zone_device'
> > Warning: drivers/thermal/thermal_core.h:152 struct member 'debugfs' not described in 'thermal_zone_device'
> > Warning: drivers/thermal/thermal_core.h:152 struct member 'user_thresholds' not described in 'thermal_zone_device'
> >
> > Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> > ---
> > Cc: Rafael J. Wysocki <rafael@kernel.org>
> > Cc: Daniel Lezcano <daniel.lezcano@linaro.org>
> > Cc: Zhang Rui <rui.zhang@intel.com>
> > Cc: Lukasz Luba <lukasz.luba@arm.com>
> > Cc: linux-pm@vger.kernel.org
> >
> >   drivers/thermal/thermal_core.h |    7 +++++--
> >   1 file changed, 5 insertions(+), 2 deletions(-)
> >
> > --- linux-next-20260126.orig/drivers/thermal/thermal_core.h
> > +++ linux-next-20260126/drivers/thermal/thermal_core.h
> > @@ -77,6 +77,7 @@ struct thermal_governor {
> >    * @device: &struct device for this thermal zone
> >    * @removal:        removal completion
> >    * @resume: resume completion
> > + * @trips_attribute_group: trip point sysfs attributes
> >    * @trips_high:     trips above the current zone temperature
> >    * @trips_reached:  trips below or at the current zone temperature
> >    * @trips_invalid:  trips with invalid temperature
> > @@ -97,9 +98,9 @@ struct thermal_governor {
> >    * @emul_temperature:       emulated temperature when using CONFIG_THERMAL_EMULATION
> >    * @passive:                1 if you've crossed a passive trip point, 0 otherwise.
> >    * @prev_low_trip:  the low current temperature if you've crossed a passive
> > -                     trip point.
> > + *                   trip point.
> >    * @prev_high_trip: the above current temperature if you've crossed a
> > -                     passive trip point.
> > + *                   passive trip point.
> >    * @ops:    operations this &thermal_zone_device supports
> >    * @tzp:    thermal zone parameters
> >    * @governor:       pointer to the governor for this thermal zone
> > @@ -111,6 +112,8 @@ struct thermal_governor {
> >    * @poll_queue:     delayed work for polling
> >    * @notify_event: Last notification event
> >    * @state:  current state of the thermal zone
> > + * @debugfs: this thermal zone device's thermal zone debug info
> > + * @user_thresholds: list of userspace thresholds for temp. limit notifications
> >    * @trips:  array of struct thermal_trip objects
> >    */
> >   struct thermal_zone_device {
>
>
> Reviewed-by: Lukasz Luba <lukasz.luba@arm.com>

Applied as 6.20 material, thanks!