Subject: [PATCH 1/3] fpga: dfl: Fix kernel-doc warning in dfl.h for revision

Fixed the following warning:
drivers/fpga/dfl.h:255: warning: Function parameter or member 'revision' not described in 'dfl_feature'

Signed-off-by: Basheer Ahmed Muddebihal <[email protected]>
---
drivers/fpga/dfl.h | 1 +
1 file changed, 1 insertion(+)

diff --git a/drivers/fpga/dfl.h b/drivers/fpga/dfl.h
index 06cfcd5e84bb..766429e618f6 100644
--- a/drivers/fpga/dfl.h
+++ b/drivers/fpga/dfl.h
@@ -231,6 +231,7 @@ struct dfl_feature_irq_ctx {
*
* @dev: ptr to pdev of the feature device which has the sub feature.
* @id: sub feature id.
+ * @revision: sub feature revision.
* @resource_index: each sub feature has one mmio resource for its registers.
* this index is used to find its mmio resource from the
* feature dev (platform device)'s resources.
--
2.34.1



2022-05-28 19:37:01

by Xu Yilun

[permalink] [raw]
Subject: Re: [PATCH 1/3] fpga: dfl: Fix kernel-doc warning in dfl.h for revision

On Thu, May 19, 2022 at 03:12:47PM -0700, Basheer Ahmed Muddebihal wrote:
> Fixed the following warning:

Please help specify which tool reports this issue here. Is it lkp?

> drivers/fpga/dfl.h:255: warning: Function parameter or member 'revision' not described in 'dfl_feature'
>

Please add the 'Fixes' tag here.
Please also add the 'Reported-by' tag here.

> Signed-off-by: Basheer Ahmed Muddebihal <[email protected]>
> ---
> drivers/fpga/dfl.h | 1 +
> 1 file changed, 1 insertion(+)
>
> diff --git a/drivers/fpga/dfl.h b/drivers/fpga/dfl.h
> index 06cfcd5e84bb..766429e618f6 100644
> --- a/drivers/fpga/dfl.h
> +++ b/drivers/fpga/dfl.h
> @@ -231,6 +231,7 @@ struct dfl_feature_irq_ctx {
> *
> * @dev: ptr to pdev of the feature device which has the sub feature.
> * @id: sub feature id.
> + * @revision: sub feature revision.
> * @resource_index: each sub feature has one mmio resource for its registers.
> * this index is used to find its mmio resource from the
> * feature dev (platform device)'s resources.
> --
> 2.34.1