Skip to contentSkip to conversation

thermal: devfreq_cooling: Fix kernel-doc

PATCH Applied Yang Li 5 participants 6 messages Jun 9, 2021 – Jul 4, 2021 Thermal

lore
Share & tools
lore

Yang Li

author
#0 lore raw

PATCH v2 1/1 thermal: devfreq_cooling: Fix kernel-doc

Fix function name in devfreq_cooling.c comment to remove a warning found by kernel-doc.

drivers/thermal/devfreq_cooling.c:479: warning: expecting prototype for devfreq_cooling_em_register_power(). Prototype was for devfreq_cooling_em_register() instead.

---

Change in v2:
--replaced s/clang(make W=1 LLVM=1)/kernel-doc/ in commit.
https://lore.kernel.org/patchwork/patch/1442639/

 drivers/thermal/devfreq_cooling.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/thermal/devfreq_cooling.c +1 -1
index 3a788ac..5a86cff 100644
@@ -458,7 +458,7 @@ struct thermal_cooling_device *devfreq_cooling_register(struct devfreq *df)
 EXPORT_SYMBOL_GPL(devfreq_cooling_register);
 
 /**
- * devfreq_cooling_em_register_power() - Register devfreq cooling device with
+ * devfreq_cooling_em_register() - Register devfreq cooling device with
  *		power information and automatically register Energy Model (EM)
  * @df:		Pointer to devfreq device.
  * @dfc_power:	Pointer to devfreq_cooling_power.
Signature · 1 line
1.8.3.1
#1 lore raw
Quoted 4 lines · Yang Li

Fix function name in devfreq_cooling.c comment to remove a warning found by kernel-doc.

Quoted 8 lines

drivers/thermal/devfreq_cooling.c:479: warning: expecting prototype for devfreq_cooling_em_register_power(). Prototype was for devfreq_cooling_em_register() instead.

I'm ok with leaving my reviewed by on _this_ patch because it's so simple but...

In general, when sending a follow up version of a patch, it's _not_ ok to add a reviewed by tag when a reviewer has not explicitly responded with "Reviewed-by: ...". That provides a false sense that a patch has been thoroughly reviewed. Responding to a patch does not constitute a "Reviewed-by:" tag.

And I might be fine with _this_ patch, but that says nothing about Nathan, whom you've also falsely attributed a reviewed by tag here.

For such a trivial patch, it's not a big deal, but in the future please do not do that again. It's ok to send v2, v3, etc, but wait for reviewers to explicitly state such reviewed by tag. The maintainer will collect those responses (and can be done so in an automated fashion via a tool like b4 (https://pypi.org/project/b4/)) when applying patches.

Quoted 25 lines

---

Change in v2:
--replaced s/clang(make W=1 LLVM=1)/kernel-doc/ in commit.
https://lore.kernel.org/patchwork/patch/1442639/

 drivers/thermal/devfreq_cooling.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/thermal/devfreq_cooling.c +1 -2
index 3a788ac..5a86cff 100644
@@ -458,7 +458,7 @@ struct thermal_cooling_device *devfreq_cooling_register(struct devfreq *df)
 EXPORT_SYMBOL_GPL(devfreq_cooling_register);
 
 /**
- * devfreq_cooling_em_register_power() - Register devfreq cooling device with
+ * devfreq_cooling_em_register() - Register devfreq cooling device with
  *             power information and automatically register Energy Model (EM)
  * @df:                Pointer to devfreq device.
  * @dfc_power: Pointer to devfreq_cooling_power.
--

1.8.3.1

Signature · 2 lines
Thanks,
~Nick Desaulniers
Reviewed-by
#2 lore raw
Quoted 25 lines · Nick Desaulniers
Quoted 4 lines · Yang Li

Fix function name in devfreq_cooling.c comment to remove a warning found by kernel-doc.

Quoted 8 lines

drivers/thermal/devfreq_cooling.c:479: warning: expecting prototype for devfreq_cooling_em_register_power(). Prototype was for devfreq_cooling_em_register() instead.

I'm ok with leaving my reviewed by on _this_ patch because it's so simple but...

In general, when sending a follow up version of a patch, it's _not_ ok to add a reviewed by tag when a reviewer has not explicitly responded with "Reviewed-by: ...". That provides a false sense that a patch has been thoroughly reviewed. Responding to a patch does not constitute a "Reviewed-by:" tag.

And I might be fine with _this_ patch, but that says nothing about Nathan, whom you've also falsely attributed a reviewed by tag here.

Quoted 6 lines

For such a trivial patch, it's not a big deal, but in the future please do not do that again. It's ok to send v2, v3, etc, but wait for reviewers to explicitly state such reviewed by tag. The maintainer will collect those responses (and can be done so in an automated fashion via a tool like b4 (https://pypi.org/project/b4/)) when applying patches.

+1 with all that was said above. Tags should be explicitly given, except for maybe the "Reported-by" and "Suggested-by" tags if the report or suggestion was done in the public forum but it is still polite to ask if it is okay to add.

For the record, my reviewed-by tag can stand:

Quoted 27 lines
Quoted 25 lines

---

Change in v2:
--replaced s/clang(make W=1 LLVM=1)/kernel-doc/ in commit.
https://lore.kernel.org/patchwork/patch/1442639/

  drivers/thermal/devfreq_cooling.c | 2 +-
  1 file changed, 1 insertion(+), 1 deletion(-)
drivers/thermal/devfreq_cooling.c +1 -2
index 3a788ac..5a86cff 100644
@@ -458,7 +458,7 @@ struct thermal_cooling_device *devfreq_cooling_register(struct devfreq *df)
  EXPORT_SYMBOL_GPL(devfreq_cooling_register);
 
  /**
- * devfreq_cooling_em_register_power() - Register devfreq cooling device with
+ * devfreq_cooling_em_register() - Register devfreq cooling device with
   *             power information and automatically register Energy Model (EM)
   * @df:                Pointer to devfreq device.
   * @dfc_power: Pointer to devfreq_cooling_power.
--

1.8.3.1

reviewer Reviewed-by on v2 1/1
#3 lore raw
In reply to Yang Li
Quoted 11 lines · Yang Li

Fix function name in devfreq_cooling.c comment to remove a warning found by kernel-doc.

drivers/thermal/devfreq_cooling.c:479: warning: expecting prototype for devfreq_cooling_em_register_power(). Prototype was for devfreq_cooling_em_register() instead.

Everything was said regarding these Reviewed-by tags and you got them in this thread, so should be OK Thank you Nathan and Nick for explaining this and sorting out.

Small hint for next time, the Signed-off-by should be at the bottom of that list.

Quoted 15 lines

---

Change in v2:
--replaced s/clang(make W=1 LLVM=1)/kernel-doc/ in commit.
https://lore.kernel.org/patchwork/patch/1442639/

  drivers/thermal/devfreq_cooling.c | 2 +-
  1 file changed, 1 insertion(+), 1 deletion(-)
drivers/thermal/devfreq_cooling.c +0 -0
index 3a788ac..5a86cff 100644

drivers/thermal/devfreq_cooling.c struct thermal_cooling_device *devfreq_cooling_register(struct devfreq *df) · line 464

Quoted 8 lines
drivers/thermal/devfreq_cooling.c +1 -1
@@ -458,7 +458,7 @@ struct thermal_cooling_device *devfreq_cooling_register(struct devfreq *df)
  EXPORT_SYMBOL_GPL(devfreq_cooling_register);
 
  /**
- * devfreq_cooling_em_register_power() - Register devfreq cooling device with
+ * devfreq_cooling_em_register() - Register devfreq cooling device with
   *		power information and automatically register Energy Model (EM)
   * @df:		Pointer to devfreq device.
   * @dfc_power:	Pointer to devfreq_cooling_power.

Apart from that, the change itself is OK. I forgot about this comment function name in some iteration... my apologies for that.

LGTM

Regards,
Lukasz Luba

merge bot Applied
#4 lore raw
In reply to Yang Li
The following commit has been merged into the thermal/next branch of thermal:

The following commit has been merged into the thermal/next branch of thermal:

Commit-ID:     8e5045645e52de63cdc8e5a65968b96411cf95d9
Gitweb:        https://git.kernel.org/pub/scm/linux/kernel/git/thermal/linux.git//8e5045645e52de63cdc8e5a65968b96411cf95d9
Author:        Yang Li <[email protected]>
AuthorDate:    Wed, 09 Jun 2021 15:22:30 +08:00
Committer:     Daniel Lezcano <[email protected]>
CommitterDate: Mon, 21 Jun 2021 16:08:36 +02:00

thermal: devfreq_cooling: Fix kernel-doc

Fix function name in devfreq_cooling.c comment to remove a warning found by kernel-doc.

drivers/thermal/devfreq_cooling.c:479: warning: expecting prototype for devfreq_cooling_em_register_power(). Prototype was for devfreq_cooling_em_register() instead.

---
 drivers/thermal/devfreq_cooling.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/thermal/devfreq_cooling.c +1 -1
index 3a788ac..5a86cff 100644
@@ -458,7 +458,7 @@ struct thermal_cooling_device *devfreq_cooling_register(struct devfreq *df)
 EXPORT_SYMBOL_GPL(devfreq_cooling_register);
 
 /**
- * devfreq_cooling_em_register_power() - Register devfreq cooling device with
+ * devfreq_cooling_em_register() - Register devfreq cooling device with
  *		power information and automatically register Energy Model (EM)
  * @df:		Pointer to devfreq device.
  * @dfc_power:	Pointer to devfreq_cooling_power.
merge bot Applied
#5 lore raw
In reply to Yang Li
The following commit has been merged into the thermal/next branch of thermal:

The following commit has been merged into the thermal/next branch of thermal:

Commit-ID:     8b2ea897328c3e042ef7c3e80503c802db24a678
Gitweb:        https://git.kernel.org/pub/scm/linux/kernel/git/thermal/linux.git//8b2ea897328c3e042ef7c3e80503c802db24a678
Author:        Yang Li <[email protected]>
AuthorDate:    Wed, 09 Jun 2021 15:22:30 +08:00
Committer:     Daniel Lezcano <[email protected]>
CommitterDate: Sun, 04 Jul 2021 18:28:04 +02:00

thermal: devfreq_cooling: Fix kernel-doc

Fix function name in devfreq_cooling.c comment to remove a warning found by kernel-doc.

drivers/thermal/devfreq_cooling.c:479: warning: expecting prototype for devfreq_cooling_em_register_power(). Prototype was for devfreq_cooling_em_register() instead.

---
 drivers/thermal/devfreq_cooling.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/thermal/devfreq_cooling.c +1 -1
index 3a788ac..5a86cff 100644
@@ -458,7 +458,7 @@ struct thermal_cooling_device *devfreq_cooling_register(struct devfreq *df)
 EXPORT_SYMBOL_GPL(devfreq_cooling_register);
 
 /**
- * devfreq_cooling_em_register_power() - Register devfreq cooling device with
+ * devfreq_cooling_em_register() - Register devfreq cooling device with
  *		power information and automatically register Energy Model (EM)
  * @df:		Pointer to devfreq device.
  * @dfc_power:	Pointer to devfreq_cooling_power.