Message ID | fe3fc4028189d45f8a20da48501e0ea09f2b5236.1573046440.git.amit.kucheria@linaro.org |
---|---|
State | New |
Headers | show |
Series | thermal: clean up output of make W=1 | expand |
On 06-11-19, 18:58, Amit Kucheria wrote: > Replace - with : to appease the kernel-doc gods and fix warnings such as > the following when compiled with make W=1: > > linux-amit.git/drivers/thermal/step_wise.c:187: warning: Function > parameter or member 'tz' not described in 'step_wise_throttle' > linux-amit.git/drivers/thermal/step_wise.c:187: warning: Function > parameter or member 'trip' not described in 'step_wise_throttle' > > linux.git/drivers/thermal/fair_share.c:79: warning: Function parameter > or member 'tz' not described in 'fair_share_throttle' > linux.git/drivers/thermal/fair_share.c:79: warning: Function parameter > or member 'trip' not described in 'fair_share_throttle' > > Signed-off-by: Amit Kucheria <amit.kucheria@linaro.org> > --- > drivers/thermal/fair_share.c | 4 ++-- > drivers/thermal/gov_bang_bang.c | 4 ++-- > drivers/thermal/step_wise.c | 4 ++-- > drivers/thermal/user_space.c | 4 ++-- > 4 files changed, 8 insertions(+), 8 deletions(-) > > diff --git a/drivers/thermal/fair_share.c b/drivers/thermal/fair_share.c > index afd99f668c65d..aaa07180ab482 100644 > --- a/drivers/thermal/fair_share.c > +++ b/drivers/thermal/fair_share.c > @@ -58,8 +58,8 @@ static long get_target_state(struct thermal_zone_device *tz, > > /** > * fair_share_throttle - throttles devices associated with the given zone > - * @tz - thermal_zone_device > - * @trip - trip point index > + * @tz: thermal_zone_device > + * @trip: trip point index > * > * Throttling Logic: This uses three parameters to calculate the new > * throttle state of the cooling devices associated with the given zone. > diff --git a/drivers/thermal/gov_bang_bang.c b/drivers/thermal/gov_bang_bang.c > index b831fc77cf64a..991a1c54296de 100644 > --- a/drivers/thermal/gov_bang_bang.c > +++ b/drivers/thermal/gov_bang_bang.c > @@ -71,8 +71,8 @@ static void thermal_zone_trip_update(struct thermal_zone_device *tz, int trip) > > /** > * bang_bang_control - controls devices associated with the given zone > - * @tz - thermal_zone_device > - * @trip - the trip point > + * @tz: thermal_zone_device > + * @trip: the trip point > * > * Regulation Logic: a two point regulation, deliver cooling state depending > * on the previous state shown in this diagram: > diff --git a/drivers/thermal/step_wise.c b/drivers/thermal/step_wise.c > index 6e051cbd824ff..2ae7198d3067c 100644 > --- a/drivers/thermal/step_wise.c > +++ b/drivers/thermal/step_wise.c > @@ -174,8 +174,8 @@ static void thermal_zone_trip_update(struct thermal_zone_device *tz, int trip) > > /** > * step_wise_throttle - throttles devices associated with the given zone > - * @tz - thermal_zone_device > - * @trip - trip point index > + * @tz: thermal_zone_device > + * @trip: trip point index > * > * Throttling Logic: This uses the trend of the thermal zone to throttle. > * If the thermal zone is 'heating up' this throttles all the cooling > diff --git a/drivers/thermal/user_space.c b/drivers/thermal/user_space.c > index 962873fd92425..293cffd9c8adb 100644 > --- a/drivers/thermal/user_space.c > +++ b/drivers/thermal/user_space.c > @@ -17,8 +17,8 @@ > > /** > * notify_user_space - Notifies user space about thermal events > - * @tz - thermal_zone_device > - * @trip - trip point index > + * @tz: thermal_zone_device > + * @trip: trip point index > * > * This function notifies the user space through UEvents. > */ Reviewed-by: Viresh Kumar <viresh.kumar@linaro.org> -- viresh
diff --git a/drivers/thermal/fair_share.c b/drivers/thermal/fair_share.c index afd99f668c65d..aaa07180ab482 100644 --- a/drivers/thermal/fair_share.c +++ b/drivers/thermal/fair_share.c @@ -58,8 +58,8 @@ static long get_target_state(struct thermal_zone_device *tz, /** * fair_share_throttle - throttles devices associated with the given zone - * @tz - thermal_zone_device - * @trip - trip point index + * @tz: thermal_zone_device + * @trip: trip point index * * Throttling Logic: This uses three parameters to calculate the new * throttle state of the cooling devices associated with the given zone. diff --git a/drivers/thermal/gov_bang_bang.c b/drivers/thermal/gov_bang_bang.c index b831fc77cf64a..991a1c54296de 100644 --- a/drivers/thermal/gov_bang_bang.c +++ b/drivers/thermal/gov_bang_bang.c @@ -71,8 +71,8 @@ static void thermal_zone_trip_update(struct thermal_zone_device *tz, int trip) /** * bang_bang_control - controls devices associated with the given zone - * @tz - thermal_zone_device - * @trip - the trip point + * @tz: thermal_zone_device + * @trip: the trip point * * Regulation Logic: a two point regulation, deliver cooling state depending * on the previous state shown in this diagram: diff --git a/drivers/thermal/step_wise.c b/drivers/thermal/step_wise.c index 6e051cbd824ff..2ae7198d3067c 100644 --- a/drivers/thermal/step_wise.c +++ b/drivers/thermal/step_wise.c @@ -174,8 +174,8 @@ static void thermal_zone_trip_update(struct thermal_zone_device *tz, int trip) /** * step_wise_throttle - throttles devices associated with the given zone - * @tz - thermal_zone_device - * @trip - trip point index + * @tz: thermal_zone_device + * @trip: trip point index * * Throttling Logic: This uses the trend of the thermal zone to throttle. * If the thermal zone is 'heating up' this throttles all the cooling diff --git a/drivers/thermal/user_space.c b/drivers/thermal/user_space.c index 962873fd92425..293cffd9c8adb 100644 --- a/drivers/thermal/user_space.c +++ b/drivers/thermal/user_space.c @@ -17,8 +17,8 @@ /** * notify_user_space - Notifies user space about thermal events - * @tz - thermal_zone_device - * @trip - trip point index + * @tz: thermal_zone_device + * @trip: trip point index * * This function notifies the user space through UEvents. */
Replace - with : to appease the kernel-doc gods and fix warnings such as the following when compiled with make W=1: linux-amit.git/drivers/thermal/step_wise.c:187: warning: Function parameter or member 'tz' not described in 'step_wise_throttle' linux-amit.git/drivers/thermal/step_wise.c:187: warning: Function parameter or member 'trip' not described in 'step_wise_throttle' linux.git/drivers/thermal/fair_share.c:79: warning: Function parameter or member 'tz' not described in 'fair_share_throttle' linux.git/drivers/thermal/fair_share.c:79: warning: Function parameter or member 'trip' not described in 'fair_share_throttle' Signed-off-by: Amit Kucheria <amit.kucheria@linaro.org> --- drivers/thermal/fair_share.c | 4 ++-- drivers/thermal/gov_bang_bang.c | 4 ++-- drivers/thermal/step_wise.c | 4 ++-- drivers/thermal/user_space.c | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) -- 2.17.1