[libcamera-devel] [PATCH v1] Documentation: guides: pipeline-handler: Fix spelling error

[Laurent Pinchart]

Hi Barnabás,

Thank you for the patch.

On Thu, Apr 27, 2023 at 08:45:15PM +0000, Barnabás Pőcze via libcamera-devel wrote:
> Both {Camera,PipelineHandler}::generateConfiguration() take a list
> of `StreamRole` objects, and not a list of `StreamRoles` objects.
> 
> Signed-off-by: Barnabás Pőcze <pobrn at protonmail.com>
> ---
>  Documentation/guides/pipeline-handler.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/guides/pipeline-handler.rst b/Documentation/guides/pipeline-handler.rst
> index 7ac6e60c..e08bb72f 100644
> --- a/Documentation/guides/pipeline-handler.rst
> +++ b/Documentation/guides/pipeline-handler.rst
> @@ -729,7 +729,7 @@ function.
>  .. _Camera::generateConfiguration(): https://libcamera.org/api-html/classlibcamera_1_1Camera.html#a25c80eb7fc9b1cf32692ce0c7f09991d
>  .. _PipelineHandler::generateConfiguration(): https://libcamera.org/api-html/classlibcamera_1_1PipelineHandler.html#a7932e87735695500ce1f8c7ae449b65b
> 
> -Configurations are generated by receiving a list of ``StreamRoles`` instances,
> +Configurations are generated by receiving a list of ``StreamRole`` instances,

We also have a StreamRoles class, but you're right, we mean StreamRole
here.

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

>  which libcamera uses as predefined ways an application intends to use a camera
>  (You can read the full list in the `StreamRole API`_ documentation). These are
>  optional hints on how an application intends to use a stream, and a pipeline

-- 
Regards,

Laurent Pinchart