[libcamera-devel] libcamera: pipeline_handler: Fix typo in documentation
diff mbox series

Message ID 20210413181226.17087-1-laurent.pinchart@ideasonboard.com
State Accepted
Commit 304ea65551b410a82b81dfd83e25b089ce158954
Headers show
Series
  • [libcamera-devel] libcamera: pipeline_handler: Fix typo in documentation
Related show

Commit Message

Laurent Pinchart April 13, 2021, 6:12 p.m. UTC
There's no CameraConfiguration::valid(), the correct function is
CameraConfiguration::validate().

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
---
 src/libcamera/pipeline_handler.cpp | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Kieran Bingham April 13, 2021, 7:50 p.m. UTC | #1
Hi Laurent,

On 13/04/2021 19:12, Laurent Pinchart wrote:
> There's no CameraConfiguration::valid(), the correct function is
> CameraConfiguration::validate().
> 

Indeed.

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


> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
> ---
>  src/libcamera/pipeline_handler.cpp | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/src/libcamera/pipeline_handler.cpp b/src/libcamera/pipeline_handler.cpp
> index 433c05f60db0..03aa865f5b36 100644
> --- a/src/libcamera/pipeline_handler.cpp
> +++ b/src/libcamera/pipeline_handler.cpp
> @@ -293,8 +293,8 @@ const ControlList &PipelineHandler::properties(const Camera *camera) const
>   * application.
>   *
>   * The configuration is guaranteed to have been validated with
> - * CameraConfiguration::valid(). The pipeline handler implementation shall not
> - * perform further validation and may rely on any custom field stored in its
> + * CameraConfiguration::validate(). The pipeline handler implementation shall
> + * not perform further validation and may rely on any custom field stored in its
>   * custom CameraConfiguration derived class.
>   *
>   * When configuring the camera the pipeline handler shall associate a Stream
>
Sebastian Fricke April 14, 2021, 3:34 a.m. UTC | #2
Hey Laurent,

On 13.04.2021 21:12, Laurent Pinchart wrote:
>There's no CameraConfiguration::valid(), the correct function is
>CameraConfiguration::validate().
>
>Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Reviewed-by: Sebastian Fricke <sebastian.fricke@posteo.net>

>---
> src/libcamera/pipeline_handler.cpp | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>
>diff --git a/src/libcamera/pipeline_handler.cpp b/src/libcamera/pipeline_handler.cpp
>index 433c05f60db0..03aa865f5b36 100644
>--- a/src/libcamera/pipeline_handler.cpp
>+++ b/src/libcamera/pipeline_handler.cpp
>@@ -293,8 +293,8 @@ const ControlList &PipelineHandler::properties(const Camera *camera) const
>  * application.
>  *
>  * The configuration is guaranteed to have been validated with
>- * CameraConfiguration::valid(). The pipeline handler implementation shall not
>- * perform further validation and may rely on any custom field stored in its
>+ * CameraConfiguration::validate(). The pipeline handler implementation shall
>+ * not perform further validation and may rely on any custom field stored in its
>  * custom CameraConfiguration derived class.
>  *
>  * When configuring the camera the pipeline handler shall associate a Stream
>-- 
>Regards,
>
>Laurent Pinchart
>
>_______________________________________________
>libcamera-devel mailing list
>libcamera-devel@lists.libcamera.org
>https://lists.libcamera.org/listinfo/libcamera-devel

Patch
diff mbox series

diff --git a/src/libcamera/pipeline_handler.cpp b/src/libcamera/pipeline_handler.cpp
index 433c05f60db0..03aa865f5b36 100644
--- a/src/libcamera/pipeline_handler.cpp
+++ b/src/libcamera/pipeline_handler.cpp
@@ -293,8 +293,8 @@  const ControlList &PipelineHandler::properties(const Camera *camera) const
  * application.
  *
  * The configuration is guaranteed to have been validated with
- * CameraConfiguration::valid(). The pipeline handler implementation shall not
- * perform further validation and may rely on any custom field stored in its
+ * CameraConfiguration::validate(). The pipeline handler implementation shall
+ * not perform further validation and may rely on any custom field stored in its
  * custom CameraConfiguration derived class.
  *
  * When configuring the camera the pipeline handler shall associate a Stream