On 1/26/21 1:45 PM, Lee Jones wrote:
> Fixes the following W=1 kernel build warning(s):
>
> drivers/clk/zynq/pll.c:187: warning: Function parameter or member 'name' not
> described in 'clk_register_zynq_pll'
> drivers/clk/zynq/pll.c:187: warning: Function parameter or member 'parent'
> not described in 'clk_register_zynq_pll'
> drivers/clk/zynq/pll.c:187: warning: Function parameter or member 'pll_ctrl'
> not described in 'clk_register_zynq_pll'
> drivers/clk/zynq/pll.c:187: warning: Function parameter or member
> 'pll_status' not described in 'clk_register_zynq_pll'
> drivers/clk/zynq/pll.c:187: warning: Function parameter or member
> 'lock_index' not described in 'clk_register_zynq_pll'
> drivers/clk/zynq/pll.c:187: warning: Function parameter or member 'lock' not
> described in 'clk_register_zynq_pll'
>
> Cc: Michael Turquette <[email protected]>
> Cc: Stephen Boyd <[email protected]>
> Cc: Michal Simek <[email protected]>
> Cc: "Sören Brinkmann" <[email protected]>
> Cc: [email protected]
> Cc: [email protected]
> Signed-off-by: Lee Jones <[email protected]>
> ---
> drivers/clk/zynq/pll.c | 12 ++++++------
> 1 file changed, 6 insertions(+), 6 deletions(-)
>
> diff --git a/drivers/clk/zynq/pll.c b/drivers/clk/zynq/pll.c
> index dcb2037a95964..54f4184de89af 100644
> --- a/drivers/clk/zynq/pll.c
> +++ b/drivers/clk/zynq/pll.c
> @@ -173,12 +173,12 @@ static const struct clk_ops zynq_pll_ops = {
>
> /**
> * clk_register_zynq_pll() - Register PLL with the clock framework
> - * @name PLL name
> - * @parent Parent clock name
> - * @pll_ctrl Pointer to PLL control register
> - * @pll_status Pointer to PLL status register
> - * @lock_index Bit index to this PLL's lock status bit in @pll_status
> - * @lock Register lock
> + * @name: PLL name
> + * @parent: Parent clock name
> + * @pll_ctrl: Pointer to PLL control register
> + * @pll_status: Pointer to PLL status register
> + * @lock_index: Bit index to this PLL's lock status bit in @pll_status
> + * @lock: Register lock
> * Returns handle to the registered clock.
> */
> struct clk *clk_register_zynq_pll(const char *name, const char *parent,
>
When you are on this we should also fix that Returns which are also
reported by kernel-doc
When your patch is applied:
[linux](master)$ ./scripts/kernel-doc -v -man drivers/clk/zynq/pll.c >
/dev/null
drivers/clk/zynq/pll.c:15: warning: missing initial short description on
line:
* struct zynq_pll
drivers/clk/zynq/pll.c:15: info: Scanning doc for struct
drivers/clk/zynq/pll.c:45: info: Scanning doc for zynq_pll_round_rate
drivers/clk/zynq/pll.c:53: warning: No description found for return
value of 'zynq_pll_round_rate'
drivers/clk/zynq/pll.c:66: info: Scanning doc for zynq_pll_recalc_rate
drivers/clk/zynq/pll.c:73: warning: No description found for return
value of 'zynq_pll_recalc_rate'
drivers/clk/zynq/pll.c:88: info: Scanning doc for zynq_pll_is_enabled
drivers/clk/zynq/pll.c:96: warning: No description found for return
value of 'zynq_pll_is_enabled'
drivers/clk/zynq/pll.c:111: info: Scanning doc for zynq_pll_enable
drivers/clk/zynq/pll.c:116: warning: No description found for return
value of 'zynq_pll_enable'
drivers/clk/zynq/pll.c:141: info: Scanning doc for zynq_pll_disable
drivers/clk/zynq/pll.c:175: info: Scanning doc for clk_register_zynq_pll
drivers/clk/zynq/pll.c:187: warning: No description found for return
value of 'clk_register_zynq_pll'
6 warnings
Can you please also fix it? It can be done in separate patch if this is
not reported by W=1.
Acked-by: Michal Simek <[email protected]>
Thanks,
Michal
