[libcamera-devel] [PATCH] Fix incorrect method in cameradata docs

[Kieran Bingham]

Hi Chris,

On 23/06/2020 11:57, chris at gregariousmammal.com wrote:
> From: Chris Chinchilla <chris at gregariousmammal.com>
> 
> Fix incorrect method in cameradata docs

We normally wouldn't just repeat the $SUBJECT.

I'll replace this with:

"""
The pipeline handler documentation incorrectly references an old API
usage of setCameraData, which should have been updated to
registerCamera() while updating pipeline handlers to ensure they all
have a pipeline-specific "CameraData" allocation.

Update the remaining documentation reference.
"""

> 
> Fixes: b581b9576abd ("libcamera: pipeline_handler: Make pipeline-specific data mandatory")
> Signed-off-by: Chris Chinchilla <chris at gregariousmammal.com>

And I'll add the following:

Reviewed-by: Umang Jain <email at uajain.com>
Reviewed-by: Laurent Pinchart <laurent.pinchart at ideasonboard.com>


Thanks.



> ---
>  src/libcamera/pipeline_handler.cpp | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/src/libcamera/pipeline_handler.cpp b/src/libcamera/pipeline_handler.cpp
> index 14dfba0..15cdc17 100644
> --- a/src/libcamera/pipeline_handler.cpp
> +++ b/src/libcamera/pipeline_handler.cpp
> @@ -46,7 +46,7 @@ LOG_DEFINE_CATEGORY(Pipeline)
>   *
>   * Pipeline handlers are expected to extend this base class with platform
>   * specific implementation, associate instances of the derived classes
> - * using the setCameraData() method, and access them at a later time
> + * using the registerCamera() method, and access them at a later time
>   * with cameraData().
>   */
>  
> 

-- 
Regards
--
Kieran