Commit 53d256e7 authored by Amit Kucheria's avatar Amit Kucheria Committed by Daniel Lezcano
Browse files

thermal: step_wise: Appease the kernel-doc deity 



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: default avatarAmit Kucheria <amit.kucheria@linaro.org>
Reviewed-by: default avatarViresh Kumar <viresh.kumar@linaro.org>
Signed-off-by: default avatarDaniel Lezcano <daniel.lezcano@linaro.org>
Link: https://lore.kernel.org/r/5d48ac6f85667a53902092ad5bbfef8cc89a7162.1574242756.git.amit.kucheria@linaro.org
parent 7b4e7f07

drivers/thermal/fair_share.c

+2 −2
Original line number Diff line number Diff line
@@ -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.

drivers/thermal/gov_bang_bang.c

+2 −2
Original line number Diff line number Diff line
@@ -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:

drivers/thermal/step_wise.c

+2 −2
Original line number Diff line number Diff line
@@ -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

drivers/thermal/user_space.c

+2 −2
Original line number Diff line number Diff line
@@ -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.

 */

CRA Git | Maintained and supported by SUSTech CRA and CCSE