LinuxLists.cc - [PATCH] clk: sunxi: usb: fix kernel-doc warnings

2024-01-21 08:57:08

Subject: [PATCH] clk: sunxi: usb: fix kernel-doc warnings

Move the function description comment to immediately above the
function implementation, the add function parameter descriptions to
prevent kernel-doc warnings:

clk-usb.c:80: warning: expecting prototype for sunxi_usb_clk_setup(). Prototype was for SUNXI_USB_MAX_SIZE() instead
clk-usb.c:91: warning: Function parameter or struct member 'node' not described in 'sunxi_usb_clk_setup'
clk-usb.c:91: warning: Function parameter or struct member 'data' not described in 'sunxi_usb_clk_setup'
clk-usb.c:91: warning: Function parameter or struct member 'lock' not described in 'sunxi_usb_clk_setup'

Signed-off-by: Randy Dunlap <[email protected]>
Cc: Emilio López <[email protected]>
Cc: Michael Turquette <[email protected]>
Cc: Stephen Boyd <[email protected]>
Cc: [email protected]
Cc: Chen-Yu Tsai <[email protected]>
Cc: Jernej Skrabec <[email protected]>
Cc: Samuel Holland <[email protected]>
Cc: [email protected]
Cc: [email protected]
---
drivers/clk/sunxi/clk-usb.c | 9 ++++++---
1 file changed, 6 insertions(+), 3 deletions(-)

diff -- a/drivers/clk/sunxi/clk-usb.c b/drivers/clk/sunxi/clk-usb.c
--- a/drivers/clk/sunxi/clk-usb.c
+++ b/drivers/clk/sunxi/clk-usb.c
@@ -73,9 +73,6 @@ static const struct reset_control_ops su
.deassert = sunxi_usb_reset_deassert,
};

-/**
- * sunxi_usb_clk_setup() - Setup function for usb gate clocks
- */

#define SUNXI_USB_MAX_SIZE 32

@@ -85,6 +82,12 @@ struct usb_clk_data {
bool reset_needs_clk;
};

+/**
+ * sunxi_usb_clk_setup() - Setup function for usb gate clocks
+ * @node: &struct device_node for the clock
+ * @data: &struct usb_clk_data for the clock
+ * @lock: spinlock for the clock
+ */
static void __init sunxi_usb_clk_setup(struct device_node *node,
const struct usb_clk_data *data,
spinlock_t *lock)

2024-01-22 10:46:27

by Andre Przywara

[permalink] [raw]

Subject: Re: [PATCH] clk: sunxi: usb: fix kernel-doc warnings

On Sat, 20 Jan 2024 21:18:57 -0800
Randy Dunlap <[email protected]> wrote:

> Move the function description comment to immediately above the
> function implementation, the add function parameter descriptions to
> prevent kernel-doc warnings:
>
> clk-usb.c:80: warning: expecting prototype for sunxi_usb_clk_setup(). Prototype was for SUNXI_USB_MAX_SIZE() instead
> clk-usb.c:91: warning: Function parameter or struct member 'node' not described in 'sunxi_usb_clk_setup'
> clk-usb.c:91: warning: Function parameter or struct member 'data' not described in 'sunxi_usb_clk_setup'
> clk-usb.c:91: warning: Function parameter or struct member 'lock' not described in 'sunxi_usb_clk_setup'

Reviewed-by: Andre Przywara <[email protected]>

Cheers,
Andre

> Signed-off-by: Randy Dunlap <[email protected]>
> Cc: Emilio López <[email protected]>
> Cc: Michael Turquette <[email protected]>
> Cc: Stephen Boyd <[email protected]>
> Cc: [email protected]
> Cc: Chen-Yu Tsai <[email protected]>
> Cc: Jernej Skrabec <[email protected]>
> Cc: Samuel Holland <[email protected]>
> Cc: [email protected]
> Cc: [email protected]
> ---
> drivers/clk/sunxi/clk-usb.c | 9 ++++++---
> 1 file changed, 6 insertions(+), 3 deletions(-)
>
> diff -- a/drivers/clk/sunxi/clk-usb.c b/drivers/clk/sunxi/clk-usb.c
> --- a/drivers/clk/sunxi/clk-usb.c
> +++ b/drivers/clk/sunxi/clk-usb.c
> @@ -73,9 +73,6 @@ static const struct reset_control_ops su
> .deassert = sunxi_usb_reset_deassert,
> };
>
> -/**
> - * sunxi_usb_clk_setup() - Setup function for usb gate clocks
> - */
>
> #define SUNXI_USB_MAX_SIZE 32
>
> @@ -85,6 +82,12 @@ struct usb_clk_data {
> bool reset_needs_clk;
> };
>
> +/**
> + * sunxi_usb_clk_setup() - Setup function for usb gate clocks
> + * @node: &struct device_node for the clock
> + * @data: &struct usb_clk_data for the clock
> + * @lock: spinlock for the clock
> + */
> static void __init sunxi_usb_clk_setup(struct device_node *node,
> const struct usb_clk_data *data,
> spinlock_t *lock)
>

2024-01-23 17:43:32

by Jernej Škrabec

[permalink] [raw]

Subject: Re: [PATCH] clk: sunxi: usb: fix kernel-doc warnings

Dne nedelja, 21. januar 2024 ob 06:18:57 CET je Randy Dunlap napisal(a):
> Move the function description comment to immediately above the
> function implementation, the add function parameter descriptions to
> prevent kernel-doc warnings:
>
> clk-usb.c:80: warning: expecting prototype for sunxi_usb_clk_setup(). Prototype was for SUNXI_USB_MAX_SIZE() instead
> clk-usb.c:91: warning: Function parameter or struct member 'node' not described in 'sunxi_usb_clk_setup'
> clk-usb.c:91: warning: Function parameter or struct member 'data' not described in 'sunxi_usb_clk_setup'
> clk-usb.c:91: warning: Function parameter or struct member 'lock' not described in 'sunxi_usb_clk_setup'
>
> Signed-off-by: Randy Dunlap <[email protected]>
> Cc: Emilio L?pez <[email protected]>
> Cc: Michael Turquette <[email protected]>
> Cc: Stephen Boyd <[email protected]>
> Cc: [email protected]
> Cc: Chen-Yu Tsai <[email protected]>
> Cc: Jernej Skrabec <[email protected]>
> Cc: Samuel Holland <[email protected]>
> Cc: [email protected]
> Cc: [email protected]

Acked-by: Jernej Skrabec <[email protected]>

Best regards,
Jernej

2024-01-23 20:58:01

by Jernej Škrabec

[permalink] [raw]