[PATCH v2] yavta: Fix usage documentation for --field option

[PATCH v2] yavta: Fix usage documentation for --field option

[Niklas Söderlund]

The --field option takes an argument selecting the field order. Update
the usage text to reflect this.

Signed-off-by: Niklas Söderlund <niklas.soderlund+renesas@ragnatech.se>
---
* Changes since v1
- List all valid filed values.
---
 yavta.c | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/yavta.c b/yavta.c
index 4e5b62a96eb66f8d..1129ab245966384b 100644
--- a/yavta.c
+++ b/yavta.c
@@ -2290,7 +2290,9 @@ static void usage(const char *argv0)
 	printf("    --enum-formats		Enumerate formats\n");
 	printf("    --enum-inputs		Enumerate inputs\n");
 	printf("    --fd                        Use a numeric file descriptor insted of a device\n");
-	printf("    --field			Interlaced format field order\n");
+	printf("    --field field		Set the format field order\n");
+	printf("\tValid values for field are none, top, bottom, interlaced, seq-tb, seq-bt\n");
+	printf("\talternate, interlaced-tb and interlaced-bt.\n");
 	printf("    --log-status		Log device status\n");
 	printf("    --no-query			Don't query capabilities on open\n");
 	printf("    --offset			User pointer buffer offset from page start\n");
-- 
2.31.1

Re: [PATCH v2] yavta: Fix usage documentation for --field option

[Laurent Pinchart]

Hi Niklas,

Thank you for the patch.

On Wed, Apr 21, 2021 at 02:18:38PM +0200, Niklas Söderlund wrote:
> The --field option takes an argument selecting the field order. Update
> the usage text to reflect this.
> 
> Signed-off-by: Niklas Söderlund <niklas.soderlund+renesas@ragnatech.se>
> ---
> * Changes since v1
> - List all valid filed values.
> ---
>  yavta.c | 4 +++-
>  1 file changed, 3 insertions(+), 1 deletion(-)
> 
> diff --git a/yavta.c b/yavta.c
> index 4e5b62a96eb66f8d..1129ab245966384b 100644
> --- a/yavta.c
> +++ b/yavta.c
> @@ -2290,7 +2290,9 @@ static void usage(const char *argv0)
>  	printf("    --enum-formats		Enumerate formats\n");
>  	printf("    --enum-inputs		Enumerate inputs\n");
>  	printf("    --fd                        Use a numeric file descriptor insted of a device\n");
> -	printf("    --field			Interlaced format field order\n");
> +	printf("    --field field		Set the format field order\n");
> +	printf("\tValid values for field are none, top, bottom, interlaced, seq-tb, seq-bt\n");

Missing ',' after seq-bt.

> +	printf("\talternate, interlaced-tb and interlaced-bt.\n");

One may argue that it would be nice to iterate over the fields array,
but that's likely overkill.

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

and applied with the added comma.

>  	printf("    --log-status		Log device status\n");
>  	printf("    --no-query			Don't query capabilities on open\n");
>  	printf("    --offset			User pointer buffer offset from page start\n");

-- 
Regards,

Laurent Pinchart