[PATCH -next] thermal: Correct typo in thermal zone documentation

[PATCH -next] thermal: Correct typo in thermal zone documentation

[Yang Li]

The term '@refcont' was corrected to '@refcount', ensuring clarity and
accuracy in the code comments.
Additionally, an obsolete comment regarding '@tt_zone' was removed, as
it was commented out in the code.

Reported-by: Abaci Robot <abaci@linux.alibaba.com>
Closes: https://bugzilla.openanolis.cn/show_bug.cgi?id=9797
Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
---
 drivers/thermal/testing/zone.c | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

diff --git a/drivers/thermal/testing/zone.c b/drivers/thermal/testing/zone.c
index fcee12b152da..173d86bcc4e2 100644
--- a/drivers/thermal/testing/zone.c
+++ b/drivers/thermal/testing/zone.c
@@ -35,7 +35,7 @@
  * @temp: Temperature value.
  * @tz_temp: Current thermal zone temperature (after registration).
  * @num_trips: Number of trip points in the @trips list.
- * @refcont: Reference counter for usage and removal synchronization.
+ * @refcount: Reference counter for usage and removal synchronization.
  */
 struct tt_thermal_zone {
 	struct list_head list_node;
@@ -60,7 +60,6 @@ DEFINE_GUARD(tt_zone, struct tt_thermal_zone *, mutex_lock(&_T->lock), mutex_unl
  * during the registration of a thermal zone based on a given zone template.
  *
  * @list_node: Node in the list of all trip template in @tt_zone.
- * @tt_zone: Zone template this trip template belongs to.
  * @trip: Trip point data to use for thernal zone registration.
  * @id: The ID of this trip template for the debugfs interface.
  */
-- 
2.32.0.3.g01195cf9f

Re: [PATCH -next] thermal: Correct typo in thermal zone documentation

[Rafael J. Wysocki]

On Thu, Aug 22, 2024 at 3:29 AM Yang Li <yang.lee@linux.alibaba.com> wrote:
>
> The term '@refcont' was corrected to '@refcount', ensuring clarity and
> accuracy in the code comments.
> Additionally, an obsolete comment regarding '@tt_zone' was removed, as
> it was commented out in the code.
>
> Reported-by: Abaci Robot <abaci@linux.alibaba.com>
> Closes: https://bugzilla.openanolis.cn/show_bug.cgi?id=9797
> Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
> ---
>  drivers/thermal/testing/zone.c | 3 +--
>  1 file changed, 1 insertion(+), 2 deletions(-)
>
> diff --git a/drivers/thermal/testing/zone.c b/drivers/thermal/testing/zone.c
> index fcee12b152da..173d86bcc4e2 100644
> --- a/drivers/thermal/testing/zone.c
> +++ b/drivers/thermal/testing/zone.c
> @@ -35,7 +35,7 @@
>   * @temp: Temperature value.
>   * @tz_temp: Current thermal zone temperature (after registration).
>   * @num_trips: Number of trip points in the @trips list.
> - * @refcont: Reference counter for usage and removal synchronization.
> + * @refcount: Reference counter for usage and removal synchronization.
>   */
>  struct tt_thermal_zone {
>         struct list_head list_node;
> @@ -60,7 +60,6 @@ DEFINE_GUARD(tt_zone, struct tt_thermal_zone *, mutex_lock(&_T->lock), mutex_unl
>   * during the registration of a thermal zone based on a given zone template.
>   *
>   * @list_node: Node in the list of all trip template in @tt_zone.
> - * @tt_zone: Zone template this trip template belongs to.
>   * @trip: Trip point data to use for thernal zone registration.
>   * @id: The ID of this trip template for the debugfs interface.
>   */
> --

Thanks for reporting this, I've fixed up the original patch and recommitted it.