[libcamera-devel] libcamera: buffer: Fix MappedBuffer::maps_ documentation

Message ID 20200902125743.61649-1-email@uajain.com
State Accepted
Commit 8117ab0a320029f97540aed2a9eebf3c759b8879
Headers show
Series
  • [libcamera-devel] libcamera: buffer: Fix MappedBuffer::maps_ documentation
Related show

Commit Message

Umang Jain Sept. 2, 2020, 12:57 p.m. UTC
Complete the brief for MappedBuffer::maps_ documentation.

Fixes: b3383da79f1d ("libcamera: buffer: Create a MappedBuffer")
Signed-off-by: Umang Jain <email@uajain.com>
---
 src/libcamera/buffer.cpp | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Kieran Bingham Sept. 2, 2020, 1 p.m. UTC | #1
Hi Umang,

On 02/09/2020 13:57, Umang Jain wrote:
> Complete the brief for MappedBuffer::maps_ documentation.
> 
> Fixes: b3383da79f1d ("libcamera: buffer: Create a MappedBuffer")

Ooops... /o\

> Signed-off-by: Umang Jain <email@uajain.com>
> ---
>  src/libcamera/buffer.cpp | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/src/libcamera/buffer.cpp b/src/libcamera/buffer.cpp
> index a094737..03f628e 100644
> --- a/src/libcamera/buffer.cpp
> +++ b/src/libcamera/buffer.cpp
> @@ -392,7 +392,7 @@ MappedBuffer::~MappedBuffer()
>  
>  /**
>   * \var MappedBuffer::maps_
> - * \brief Stores the internal
> + * \brief Stores the internal mapped planes

Though maybe we don't need the word 'internal' there .. but either way.

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

>   *
>   * MappedBuffer derived classes shall store the mappings they create in this
>   * vector which is parsed during destruct to unmap any memory mappings which
>
Niklas Söderlund Sept. 4, 2020, 6:05 a.m. UTC | #2
Hi Umang,

Thanks for your patch.

On 2020-09-02 18:27:43 +0530, Umang Jain wrote:
> Complete the brief for MappedBuffer::maps_ documentation.
> 
> Fixes: b3383da79f1d ("libcamera: buffer: Create a MappedBuffer")
> Signed-off-by: Umang Jain <email@uajain.com>

Reviewed-by: Niklas Söderlund <niklas.soderlund@ragnatech.se>

> ---
>  src/libcamera/buffer.cpp | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/src/libcamera/buffer.cpp b/src/libcamera/buffer.cpp
> index a094737..03f628e 100644
> --- a/src/libcamera/buffer.cpp
> +++ b/src/libcamera/buffer.cpp
> @@ -392,7 +392,7 @@ MappedBuffer::~MappedBuffer()
>  
>  /**
>   * \var MappedBuffer::maps_
> - * \brief Stores the internal
> + * \brief Stores the internal mapped planes
>   *
>   * MappedBuffer derived classes shall store the mappings they create in this
>   * vector which is parsed during destruct to unmap any memory mappings which
> -- 
> 2.26.2
> 
> _______________________________________________
> libcamera-devel mailing list
> libcamera-devel@lists.libcamera.org
> https://lists.libcamera.org/listinfo/libcamera-devel

Patch

diff --git a/src/libcamera/buffer.cpp b/src/libcamera/buffer.cpp
index a094737..03f628e 100644
--- a/src/libcamera/buffer.cpp
+++ b/src/libcamera/buffer.cpp
@@ -392,7 +392,7 @@  MappedBuffer::~MappedBuffer()
 
 /**
  * \var MappedBuffer::maps_
- * \brief Stores the internal
+ * \brief Stores the internal mapped planes
  *
  * MappedBuffer derived classes shall store the mappings they create in this
  * vector which is parsed during destruct to unmap any memory mappings which