[libcamera-devel] [SimpleCam PATCH 2/4] simple-cam: Improve documentation of validate/configure

[Jacopo Mondi]

On Tue, Aug 24, 2021 at 03:24:48PM +0100, Kieran Bingham wrote:
> The validation and configure phase has a couple of grammatical errors.
> Fix them and reflow the text accordingly.
>
> Signed-off-by: Kieran Bingham <kieran.bingham at ideasonboard.com>
> ---
>  simple-cam.cpp | 9 +++++----
>  1 file changed, 5 insertions(+), 4 deletions(-)
>
> diff --git a/simple-cam.cpp b/simple-cam.cpp
> index 5c16db67700c..2e646a5485c9 100644
> --- a/simple-cam.cpp
> +++ b/simple-cam.cpp
> @@ -255,16 +255,17 @@ int main()
>  #endif
>
>  	/*
> -	 * Validating a CameraConfiguration -before- applying it adjust it
> -	 * to a valid configuration as closest as possible to the requested one.
> +	 * Validating a CameraConfiguration -before- applying it will adjust it
> +	 * to a valid configuration which is as close as possible to the one
> +	 * requested.

I feel a bit silly for arguing about English language with you but
in my mind this sounds better as "to the requested one" ?

Reviewed-by: Jacopo Mondi <jacopo at jmondi.org>

Thanks
  j


>  	 */
>  	config->validate();
>  	std::cout << "Validated viewfinder configuration is: "
>  		  << streamConfig.toString() << std::endl;
>
>  	/*
> -	 * Once we have a validate configuration, we can apply it
> -	 * to the Camera.
> +	 * Once we have a validated configuration, we can apply it to the
> +	 * Camera.
>  	 */
>  	camera->configure(config.get());
>
> --
> 2.30.2
>