media: media-entity.h: Fix documentation for media_create_intf_link

[PATCH] media: media-entity.h: Fix documentation for media_create_intf_link

Posted by Ian Jamison 4 years, 2 months ago

The documentation comment was inserted between the return type
and the function name. Reunite the lines.

Signed-off-by: Ian Jamison <ian.dev@arkver.com>
Fixes: db7ee32aa185 ("[media] media-device.h: Improve documentation and update it")
---
 include/media/media-entity.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/include/media/media-entity.h b/include/media/media-entity.h
index 742918962d46..9bc9a55df71e 100644
--- a/include/media/media-entity.h
+++ b/include/media/media-entity.h
@@ -1030,7 +1030,6 @@ __must_check media_devnode_create(struct media_device *mdev,
  * removed.
  */
 void media_devnode_remove(struct media_intf_devnode *devnode);
-struct media_link *
 
 /**
  * media_create_intf_link() - creates a link between an entity and an interface
@@ -1061,6 +1060,7 @@ struct media_link *
  *    the interface and media_device_register_entity() should be called for the
  *    interface that will be part of the link.
  */
+struct media_link *
 __must_check media_create_intf_link(struct media_entity *entity,
 				    struct media_interface *intf,
 				    u32 flags);
-- 
2.35.1

Re: [PATCH] media: media-entity.h: Fix documentation for media_create_intf_link

Posted by Kieran Bingham 4 years, 2 months ago

Quoting Ian Jamison (2022-04-08 18:53:45)
> The documentation comment was inserted between the return type
> and the function name. Reunite the lines.
> 
> Signed-off-by: Ian Jamison <ian.dev@arkver.com>
> Fixes: db7ee32aa185 ("[media] media-device.h: Improve documentation and update it")
> ---
>  include/media/media-entity.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/include/media/media-entity.h b/include/media/media-entity.h
> index 742918962d46..9bc9a55df71e 100644
> --- a/include/media/media-entity.h
> +++ b/include/media/media-entity.h
> @@ -1030,7 +1030,6 @@ __must_check media_devnode_create(struct media_device *mdev,
>   * removed.
>   */
>  void media_devnode_remove(struct media_intf_devnode *devnode);
> -struct media_link *

Eeep. I guess that was some sort of merge conflict resolution that
didn't quite get it right sometime.

But definitely a good fix.

Reviewed-by: Kieran Bingham <kieran.bingham+renesas@ideasonboard.com>

>  
>  /**
>   * media_create_intf_link() - creates a link between an entity and an interface
> @@ -1061,6 +1060,7 @@ struct media_link *
>   *    the interface and media_device_register_entity() should be called for the
>   *    interface that will be part of the link.
>   */
> +struct media_link *
>  __must_check media_create_intf_link(struct media_entity *entity,
>                                     struct media_interface *intf,
>                                     u32 flags);
> -- 
> 2.35.1
>

Re: [PATCH] media: media-entity.h: Fix documentation for media_create_intf_link

Posted by Laurent Pinchart 4 years, 2 months ago

On Sat, Apr 09, 2022 at 08:25:40PM +0100, Kieran Bingham wrote:
> Quoting Ian Jamison (2022-04-08 18:53:45)
> > The documentation comment was inserted between the return type
> > and the function name. Reunite the lines.
> > 
> > Signed-off-by: Ian Jamison <ian.dev@arkver.com>
> > Fixes: db7ee32aa185 ("[media] media-device.h: Improve documentation and update it")
> > ---
> >  include/media/media-entity.h | 2 +-
> >  1 file changed, 1 insertion(+), 1 deletion(-)
> > 
> > diff --git a/include/media/media-entity.h b/include/media/media-entity.h
> > index 742918962d46..9bc9a55df71e 100644
> > --- a/include/media/media-entity.h
> > +++ b/include/media/media-entity.h
> > @@ -1030,7 +1030,6 @@ __must_check media_devnode_create(struct media_device *mdev,
> >   * removed.
> >   */
> >  void media_devnode_remove(struct media_intf_devnode *devnode);
> > -struct media_link *
> 
> Eeep. I guess that was some sort of merge conflict resolution that
> didn't quite get it right sometime.
> 
> But definitely a good fix.
> 
> Reviewed-by: Kieran Bingham <kieran.bingham+renesas@ideasonboard.com>

Indeed.

Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>

> >  /**
> >   * media_create_intf_link() - creates a link between an entity and an interface
> > @@ -1061,6 +1060,7 @@ struct media_link *
> >   *    the interface and media_device_register_entity() should be called for the
> >   *    interface that will be part of the link.
> >   */
> > +struct media_link *
> >  __must_check media_create_intf_link(struct media_entity *entity,
> >                                     struct media_interface *intf,
> >                                     u32 flags);

-- 
Regards,

Laurent Pinchart