Skip to contentSkip to conversation

yavta: Fix usage documentation for --field option

PATCH In review Niklas Söderlund 3 participants 6 messages Dec 9, 2019 – Apr 21, 2021

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 yavta: Fix usage documentation for --field option

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

---
 yavta.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
yavta.c +1 -1
index f83e143c051396c4..196345c323c662d3 100644
@@ -2286,7 +2286,7 @@ 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("    --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");
Signature · 1 line
2.24.0
#1 lore raw

Hi Niklas,

Quoted 13 lines · Niklas Söderlund

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

---
 yavta.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
yavta.c +0 -0
index f83e143c051396c4..196345c323c662d3 100644

yavta.c static void usage(const char *argv0) · line 2289

Quoted 5 lines
yavta.c +1 -1
@@ -2286,7 +2286,7 @@ 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");

"Valid values for field are ..."?

yavta.c static void usage(const char *argv0) · line 2292

Quoted 3 lines
yavta.c +0 -0
        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");

Gr{oetje,eeting}s,

Geert

Signature · 5 lines
Geert Uytterhoeven -- There's lots of Linux beyond ia32 -- [email protected]

In personal conversations with technical people, I call myself a hacker. But
when I'm talking to journalists I just say "programmer" or something like that.
                                -- Linus Torvalds
#2 lore raw

Hi Niklas,

Quoted 9 lines · Geert Uytterhoeven
Quoted 8 lines · Niklas Söderlund

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

---
 yavta.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Quoted 12 lines

yavta.c static void usage(const char *argv0) · line 2289

Quoted 10 lines
yavta.c +1 -1
index f83e143c051396c4..196345c323c662d3 100644
@@ -2286,7 +2286,7 @@ 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");

"Valid values for field are ..."?

Please let me know if you want to send a v2. yavta is a low-level tool so I don't think this is critical, users are expected to know that the value comes from the V4L2 API, but stating hit wouldn't hurt either.

Quoted 3 lines
Quoted 3 lines
yavta.c +0 -0
        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");
Signature · 3 lines
Regards,

Laurent Pinchart
#3 lore raw

Hi Laurent,

Thanks for your feedback.

Quoted 25 lines · Laurent Pinchart

Hi Niklas,

Quoted 9 lines · Geert Uytterhoeven
Quoted 8 lines · Niklas Söderlund

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

---
 yavta.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Quoted 12 lines

yavta.c static void usage(const char *argv0) · line 2289

Quoted 10 lines
yavta.c +1 -1
index f83e143c051396c4..196345c323c662d3 100644
@@ -2286,7 +2286,7 @@ 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");

"Valid values for field are ..."?

Quoted 3 lines

Please let me know if you want to send a v2. yavta is a low-level tool so I don't think this is critical, users are expected to know that the value comes from the V4L2 API, but stating hit wouldn't hurt either.

I'm open to send a v2 based out your feedback.

I was prompted to write this patch when writing a test for vin-tests for TB/BT and I had to look in the yavta sources to find which strings yavta used for the different field options and misinterpreting the help for --field to only concern interlaced field formats.

As you state yavta is a low-level tool so I'm fine with the patch as is just to demonstrate that the --field argument takes a value and is not exclusive to interlaced formats or extend it similar to '--format help'.

Quoted 9 lines
Quoted 4 lines
Quoted 4 lines
yavta.c +0 -0
        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");
Signature · 3 lines
Regards,

Laurent Pinchart
Signature · 2 lines
Regards,
Niklas Söderlund
#4 lore raw

Hi Laurent,

Necro ping :-)

Quoted 58 lines · Niklas Söderlund

Hi Laurent,

Thanks for your feedback.

Quoted 25 lines · Laurent Pinchart

Hi Niklas,

Quoted 9 lines · Geert Uytterhoeven
Quoted 8 lines · Niklas Söderlund

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

---
 yavta.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Quoted 12 lines

yavta.c static void usage(const char *argv0) · line 2289

Quoted 10 lines
yavta.c +1 -1
index f83e143c051396c4..196345c323c662d3 100644
@@ -2286,7 +2286,7 @@ 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");

"Valid values for field are ..."?

Quoted 3 lines

Please let me know if you want to send a v2. yavta is a low-level tool so I don't think this is critical, users are expected to know that the value comes from the V4L2 API, but stating hit wouldn't hurt either.

I'm open to send a v2 based out your feedback.

I was prompted to write this patch when writing a test for vin-tests for TB/BT and I had to look in the yavta sources to find which strings yavta used for the different field options and misinterpreting the help for --field to only concern interlaced field formats.

As you state yavta is a low-level tool so I'm fine with the patch as is just to demonstrate that the --field argument takes a value and is not exclusive to interlaced formats or extend it similar to '--format help'.

Quoted 9 lines
Quoted 4 lines
Quoted 4 lines
yavta.c +0 -0
        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");
Signature · 3 lines
Regards,

Laurent Pinchart
Signature · 2 lines
Regards,
Niklas Söderlund
Signature · 2 lines
Regards,
Niklas Söderlund
#5 lore raw
In reply to Niklas Söderlund

Hi Niklas,

Quoted 30 lines · Niklas Söderlund
Quoted 23 lines · Laurent Pinchart
Quoted 9 lines · Geert Uytterhoeven
Quoted 8 lines · Niklas Söderlund

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

---
 yavta.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Quoted 12 lines

yavta.c static void usage(const char *argv0) · line 2289

Quoted 10 lines
yavta.c +1 -1
index f83e143c051396c4..196345c323c662d3 100644
@@ -2286,7 +2286,7 @@ 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");

"Valid values for field are ..."?

Quoted 3 lines

Please let me know if you want to send a v2. yavta is a low-level tool so I don't think this is critical, users are expected to know that the value comes from the V4L2 API, but stating hit wouldn't hurt either.

I'm open to send a v2 based out your feedback.

Quoted 8 lines

I was prompted to write this patch when writing a test for vin-tests for TB/BT and I had to look in the yavta sources to find which strings yavta used for the different field options and misinterpreting the help for --field to only concern interlaced field formats.

As you state yavta is a low-level tool so I'm fine with the patch as is just to demonstrate that the --field argument takes a value and is not exclusive to interlaced formats or extend it similar to '--format help'.

Listing the supported values in the help text would be helpful I think. As the number of possible values for the field is limited, I don't think we need '--field help'. "Valid values for field are TB, BT, ..." should be short enough.

Quoted 3 lines
Quoted 3 lines
Quoted 3 lines
Quoted 3 lines
yavta.c +0 -0
        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");
Signature · 3 lines
Regards,

Laurent Pinchart