fpga: bridge: fix kernel-doc parameter description

Message ID 20230301140309.512578-1-marpagan@redhat.com
State New
Headers
Series fpga: bridge: fix kernel-doc parameter description |

Commit Message

Marco Pagani March 1, 2023, 2:03 p.m. UTC
  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 <marpagan@redhat.com>
---
 drivers/fpga/fpga-bridge.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
  

Comments

Tom Rix March 2, 2023, 12:51 p.m. UTC | #1
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 <marpagan@redhat.com>
Reviewed-by: Tom Rix <trix@redhat.com>
> ---
>   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.
>    *
  
Xu Yilun March 4, 2023, 3:29 p.m. UTC | #2
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 <marpagan@redhat.com>
> Reviewed-by: Tom Rix <trix@redhat.com>

Acked-by: Xu Yilun <yilun.xu@intel.com>

> > ---
> >   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.
> >    *
>
  

Patch

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.
  *