[libcamera-devel] libcamera: framebuffer_allocator: Fix spelling

Message ID 20200204155717.7784-1-kieran.bingham@ideasonboard.com
State Accepted
Commit fd6f3e2a65fe7842a9ff357299607b07a4e36047
Headers show
Series
  • [libcamera-devel] libcamera: framebuffer_allocator: Fix spelling
Related show

Commit Message

Kieran Bingham Feb. 4, 2020, 3:57 p.m. UTC
Fix two trivial issues in the documentation of the FrameBufferAllocater
class.

Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
---
 src/libcamera/framebuffer_allocator.cpp | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Laurent Pinchart Feb. 4, 2020, 4:09 p.m. UTC | #1
Hi Kieran,

Thank you for the patch.

On Tue, Feb 04, 2020 at 03:57:17PM +0000, Kieran Bingham wrote:
> Fix two trivial issues in the documentation of the FrameBufferAllocater
> class.
> 
> Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>

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

> ---
>  src/libcamera/framebuffer_allocator.cpp | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/src/libcamera/framebuffer_allocator.cpp b/src/libcamera/framebuffer_allocator.cpp
> index 4ced10cda2e3..e79f4a8f65c8 100644
> --- a/src/libcamera/framebuffer_allocator.cpp
> +++ b/src/libcamera/framebuffer_allocator.cpp
> @@ -33,7 +33,7 @@ LOG_DEFINE_CATEGORY(Allocator)
>   * FrameBuffer instances. This makes libcamera a user of buffers exported by
>   * other devices (such as displays or video encoders), or allocated from an
>   * external allocator (such as ION on Android platforms). In some situations,
> - * applications do not have any mean to allocate or get hold of suitable
> + * applications do not have any means to allocate or get hold of suitable
>   * buffers, for instance when no other device is involved, on Linux platforms
>   * that lack a centralized allocator. The FrameBufferAllocator class provides a
>   * buffer allocator that can be used in these situations.
> @@ -168,7 +168,7 @@ int FrameBufferAllocator::free(Stream *stream)
>  
>  /**
>   * \brief Retrieve the buffers allocated for a \a stream
> - * \param[in] stream The stream to retrive buffers for
> + * \param[in] stream The stream to retrieve buffers for
>   *
>   * This method shall only be called after successfully allocating buffers for
>   * \a stream with allocate(). The returned buffers are valid until free() is

Patch

diff --git a/src/libcamera/framebuffer_allocator.cpp b/src/libcamera/framebuffer_allocator.cpp
index 4ced10cda2e3..e79f4a8f65c8 100644
--- a/src/libcamera/framebuffer_allocator.cpp
+++ b/src/libcamera/framebuffer_allocator.cpp
@@ -33,7 +33,7 @@  LOG_DEFINE_CATEGORY(Allocator)
  * FrameBuffer instances. This makes libcamera a user of buffers exported by
  * other devices (such as displays or video encoders), or allocated from an
  * external allocator (such as ION on Android platforms). In some situations,
- * applications do not have any mean to allocate or get hold of suitable
+ * applications do not have any means to allocate or get hold of suitable
  * buffers, for instance when no other device is involved, on Linux platforms
  * that lack a centralized allocator. The FrameBufferAllocator class provides a
  * buffer allocator that can be used in these situations.
@@ -168,7 +168,7 @@  int FrameBufferAllocator::free(Stream *stream)
 
 /**
  * \brief Retrieve the buffers allocated for a \a stream
- * \param[in] stream The stream to retrive buffers for
+ * \param[in] stream The stream to retrieve buffers for
  *
  * This method shall only be called after successfully allocating buffers for
  * \a stream with allocate(). The returned buffers are valid until free() is