2023-03-01 14:04:11

by Marco Pagani

[permalink] [raw]
Subject: [PATCH] fpga: bridge: fix kernel-doc parameter description

Fix the kernel-doc description for the "struct fpga_image_info *info"
parameter of the fpga_bridge_get() function.

Fixes: 060ac5c8fa7b ("fpga: bridge: kernel-doc fixes")
Signed-off-by: Marco Pagani <[email protected]>
---
drivers/fpga/fpga-bridge.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/fpga/fpga-bridge.c b/drivers/fpga/fpga-bridge.c
index 5cd40acab5bf..ff4470067ed5 100644
--- a/drivers/fpga/fpga-bridge.c
+++ b/drivers/fpga/fpga-bridge.c
@@ -115,7 +115,7 @@ static int fpga_bridge_dev_match(struct device *dev, const void *data)
/**
* fpga_bridge_get - get an exclusive reference to an fpga bridge
* @dev: parent device that fpga bridge was registered with
- * @info: fpga manager info
+ * @info: fpga image specific information
*
* Given a device, get an exclusive reference to an fpga bridge.
*
--
2.39.2



2023-03-02 12:52:31

by Tom Rix

[permalink] [raw]
Subject: Re: [PATCH] fpga: bridge: fix kernel-doc parameter description


On 3/1/23 6:03 AM, Marco Pagani wrote:
> Fix the kernel-doc description for the "struct fpga_image_info *info"
> parameter of the fpga_bridge_get() function.
>
> Fixes: 060ac5c8fa7b ("fpga: bridge: kernel-doc fixes")
> Signed-off-by: Marco Pagani <[email protected]>
Reviewed-by: Tom Rix <[email protected]>
> ---
> drivers/fpga/fpga-bridge.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/drivers/fpga/fpga-bridge.c b/drivers/fpga/fpga-bridge.c
> index 5cd40acab5bf..ff4470067ed5 100644
> --- a/drivers/fpga/fpga-bridge.c
> +++ b/drivers/fpga/fpga-bridge.c
> @@ -115,7 +115,7 @@ static int fpga_bridge_dev_match(struct device *dev, const void *data)
> /**
> * fpga_bridge_get - get an exclusive reference to an fpga bridge
> * @dev: parent device that fpga bridge was registered with
> - * @info: fpga manager info
> + * @info: fpga image specific information
> *
> * Given a device, get an exclusive reference to an fpga bridge.
> *


2023-03-04 15:41:32

by Xu Yilun

[permalink] [raw]
Subject: Re: [PATCH] fpga: bridge: fix kernel-doc parameter description

On 2023-03-02 at 04:51:43 -0800, Tom Rix wrote:
>
> On 3/1/23 6:03 AM, Marco Pagani wrote:
> > Fix the kernel-doc description for the "struct fpga_image_info *info"
> > parameter of the fpga_bridge_get() function.
> >
> > Fixes: 060ac5c8fa7b ("fpga: bridge: kernel-doc fixes")
> > Signed-off-by: Marco Pagani <[email protected]>
> Reviewed-by: Tom Rix <[email protected]>

Acked-by: Xu Yilun <[email protected]>

> > ---
> > drivers/fpga/fpga-bridge.c | 2 +-
> > 1 file changed, 1 insertion(+), 1 deletion(-)
> >
> > diff --git a/drivers/fpga/fpga-bridge.c b/drivers/fpga/fpga-bridge.c
> > index 5cd40acab5bf..ff4470067ed5 100644
> > --- a/drivers/fpga/fpga-bridge.c
> > +++ b/drivers/fpga/fpga-bridge.c
> > @@ -115,7 +115,7 @@ static int fpga_bridge_dev_match(struct device *dev, const void *data)
> > /**
> > * fpga_bridge_get - get an exclusive reference to an fpga bridge
> > * @dev: parent device that fpga bridge was registered with
> > - * @info: fpga manager info
> > + * @info: fpga image specific information
> > *
> > * Given a device, get an exclusive reference to an fpga bridge.
> > *
>