[libcamera-devel] [PATCH 3/3] libcamera: pipeline_handler: Document requestSequence_

[Laurent Pinchart]

Hi Kieran,

Thank you for the patch.

On Tue, Apr 13, 2021 at 01:25:34PM +0100, Kieran Bingham wrote:
> The documentation for requestSequence_ was not added when the sequence
> number was implemented.
> 
> Provide it.
> 
> Fixes: d874b3e34173 ("libcamera: request: Provide a sequence number")
> Signed-off-by: Kieran Bingham <kieran.bingham at ideasonboard.com>

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

> ---
>  src/libcamera/pipeline_handler.cpp | 11 +++++++++++
>  1 file changed, 11 insertions(+)
> 
> diff --git a/src/libcamera/pipeline_handler.cpp b/src/libcamera/pipeline_handler.cpp
> index 433c05f60db0..43395b57d818 100644
> --- a/src/libcamera/pipeline_handler.cpp
> +++ b/src/libcamera/pipeline_handler.cpp
> @@ -97,6 +97,17 @@ LOG_DEFINE_CATEGORY(Pipeline)
>   * when creating the camera, and shall not be modified afterwards.
>   */
>  
> +/**
> + * \var CameraData::requestSequence_
> + * \brief The queuing sequence of the request
> + *
> + * When requests are queued, they are given a per-camera sequence number to
> + * facilitate debugging of internal request usage.
> + *
> + * The requestSequence_ tracks the number of requests queued to a camera
> + * over its lifetime.
> + */
> +
>  /**
>   * \class PipelineHandler
>   * \brief Create and manage cameras based on a set of media devices

-- 
Regards,

Laurent Pinchart