Hi all,
After merging the pwm tree, today's linux-next build (htmldocs) produced
this warning:
include/linux/pwm.h:304: warning: Function parameter or member 'id' not described in 'pwm_chip'
Introduced by commit
c572f3b9c8b7 ("pwm: Replace PWM chip unique base by unique ID")
--
Cheers,
Stephen Rothwell
Commit c572f3b9c8b7 ("pwm: Replace PWM chip unique base by unique ID")
changed the members of struct pwm_chip, but failed to update the
documentation accordingly. Catch up and document the new member and drop
description for the two removed ones.
Reported-by: Stephen Rothwell <[email protected]>
Signed-off-by: Uwe Kleine-König <[email protected]>
---
include/linux/pwm.h | 3 +--
1 file changed, 1 insertion(+), 2 deletions(-)
diff --git a/include/linux/pwm.h b/include/linux/pwm.h
index c27a4bb76012..f87655c06c82 100644
--- a/include/linux/pwm.h
+++ b/include/linux/pwm.h
@@ -281,11 +281,10 @@ struct pwm_ops {
* @dev: device providing the PWMs
* @ops: callbacks for this PWM controller
* @owner: module providing this chip
- * @base: number of first PWM controlled by this chip
+ * @id: unique number of this PWM chip
* @npwm: number of PWMs controlled by this chip
* @of_xlate: request a PWM device given a device tree PWM specifier
* @of_pwm_n_cells: number of cells expected in the device tree PWM specifier
- * @list: list node for internal use
* @pwms: array of PWM devices allocated by the framework
*/
struct pwm_chip {
base-commit: 5d67b8f81b9d598599366214e3b2eb5f84003c9f
--
2.42.0
On Wed, 29 Nov 2023 11:18:32 +0100, Uwe Kleine-König wrote:
> Commit c572f3b9c8b7 ("pwm: Replace PWM chip unique base by unique ID")
> changed the members of struct pwm_chip, but failed to update the
> documentation accordingly. Catch up and document the new member and drop
> description for the two removed ones.
>
>
Applied, thanks!
[1/1] pwm: Update kernel doc for struct pwm_chip
commit: 53a2eaaf19c4e652ac53b5b2441582a555768516
Best regards,
--
Thierry Reding <[email protected]>