[libcamera-devel,3/3] libcamera: framebuffer: Add a missing space in documentation
diff mbox series

Message ID 20220317104740.569310-4-umang.jain@ideasonboard.com
State Accepted
Delegated to: Umang Jain
Headers show
Series
  • v4l2_videodevice: Small fixup & clarifications
Related show

Commit Message

Umang Jain March 17, 2022, 10:47 a.m. UTC
s/bytesused/bytes used/

Signed-off-by: Umang Jain <umang.jain@ideasonboard.com>
---
 src/libcamera/framebuffer.cpp | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Laurent Pinchart March 23, 2022, 12:17 a.m. UTC | #1
Hi Umang,

Thank you for the patch.

On Thu, Mar 17, 2022 at 04:17:40PM +0530, Umang Jain via libcamera-devel wrote:
> s/bytesused/bytes used/
> 
> Signed-off-by: Umang Jain <umang.jain@ideasonboard.com>
> ---
>  src/libcamera/framebuffer.cpp | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/src/libcamera/framebuffer.cpp b/src/libcamera/framebuffer.cpp
> index 049b1c7e..142e2af7 100644
> --- a/src/libcamera/framebuffer.cpp
> +++ b/src/libcamera/framebuffer.cpp
> @@ -30,7 +30,7 @@ LOG_DEFINE_CATEGORY(Buffer)
>   * \brief Metadata related to a captured frame
>   *
>   * The FrameMetadata structure stores all metadata related to a captured frame,
> - * as stored in a FrameBuffer, such as capture status, timestamp and bytesused.
> + * as stored in a FrameBuffer, such as capture status, timestamp and bytes used.

This may have been meant to refer to FrameMetadata::Plane::bytesused,
but a space doesn't hurt.

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

>   */
>  
>  /**
Kieran Bingham March 23, 2022, 10:34 a.m. UTC | #2
Quoting Laurent Pinchart via libcamera-devel (2022-03-23 00:17:52)
> Hi Umang,
> 
> Thank you for the patch.
> 
> On Thu, Mar 17, 2022 at 04:17:40PM +0530, Umang Jain via libcamera-devel wrote:
> > s/bytesused/bytes used/
> > 
> > Signed-off-by: Umang Jain <umang.jain@ideasonboard.com>
> > ---
> >  src/libcamera/framebuffer.cpp | 2 +-
> >  1 file changed, 1 insertion(+), 1 deletion(-)
> > 
> > diff --git a/src/libcamera/framebuffer.cpp b/src/libcamera/framebuffer.cpp
> > index 049b1c7e..142e2af7 100644
> > --- a/src/libcamera/framebuffer.cpp
> > +++ b/src/libcamera/framebuffer.cpp
> > @@ -30,7 +30,7 @@ LOG_DEFINE_CATEGORY(Buffer)
> >   * \brief Metadata related to a captured frame
> >   *
> >   * The FrameMetadata structure stores all metadata related to a captured frame,
> > - * as stored in a FrameBuffer, such as capture status, timestamp and bytesused.
> > + * as stored in a FrameBuffer, such as capture status, timestamp and bytes used.
> 
> This may have been meant to refer to FrameMetadata::Plane::bytesused,
> but a space doesn't hurt.

I would say it does refer to that, so I don't think this patch is
needed.

But if you want to keep it, I don't mind either...

Acked-by: Kieran Bingham <kieran.bingham@ideasonboard.com>

> 
> Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
> 
> >   */
> >  
> >  /**
> 
> -- 
> Regards,
> 
> Laurent Pinchart

Patch
diff mbox series

diff --git a/src/libcamera/framebuffer.cpp b/src/libcamera/framebuffer.cpp
index 049b1c7e..142e2af7 100644
--- a/src/libcamera/framebuffer.cpp
+++ b/src/libcamera/framebuffer.cpp
@@ -30,7 +30,7 @@  LOG_DEFINE_CATEGORY(Buffer)
  * \brief Metadata related to a captured frame
  *
  * The FrameMetadata structure stores all metadata related to a captured frame,
- * as stored in a FrameBuffer, such as capture status, timestamp and bytesused.
+ * as stored in a FrameBuffer, such as capture status, timestamp and bytes used.
  */
 
 /**