Re: sndiod: Remove ambiguous use of 'last' in man page

2021-12-18 Thread Alexandre Ratchov
On Sat, Dec 18, 2021 at 10:27:34AM +, Jason McIntyre wrote:
> On Sat, Dec 18, 2021 at 10:51:28AM +0100, Richard Ulmer wrote:
> > Hi,
> > after reading about using USB audio interfaces in
> > https://www.openbsd.org/faq/faq13.html I looked up what -F and -f mean
> > in sndiod(8) but was briefly confused by the word 'last'. I commonly
> > understand 'last' as either 'previous' or 'at the end of the list' and
> > in this case the latter popped into my head first, which is the wrong
> > meaning in this case (if I'm not misunderstanding things).
> > 
> 
> hi.
> 
> i agree that "previous" is probably less ambiguous, so i'm ok with that
> change.
> 
> > Maybe the attached patch could prevent this confusion. I also changed
> > 'options' to singular, because it seems to me like it refers to the
> > (single) previous -f/-F option.
> > 
> 
> this one really depends on how the options are thought of, so either
> version is ok really. but with your proposed word change of "previous",
> singulAr does read better.
> 
> so, i'm fine with this diff and happy to commit. i'll let it sit a
> little in case anyone has an issue (i.e. we've both misunderstood the
> text!)
> 

thanks, both changes makes the man page better explain what the
code does

ok ratchov



Re: sndiod: Remove ambiguous use of 'last' in man page

2021-12-18 Thread Jason McIntyre
On Sat, Dec 18, 2021 at 10:51:28AM +0100, Richard Ulmer wrote:
> Hi,
> after reading about using USB audio interfaces in
> https://www.openbsd.org/faq/faq13.html I looked up what -F and -f mean
> in sndiod(8) but was briefly confused by the word 'last'. I commonly
> understand 'last' as either 'previous' or 'at the end of the list' and
> in this case the latter popped into my head first, which is the wrong
> meaning in this case (if I'm not misunderstanding things).
> 

hi.

i agree that "previous" is probably less ambiguous, so i'm ok with that
change.

> Maybe the attached patch could prevent this confusion. I also changed
> 'options' to singular, because it seems to me like it refers to the
> (single) previous -f/-F option.
> 

this one really depends on how the options are thought of, so either
version is ok really. but with your proposed word change of "previous",
singulAr does read better.

so, i'm fine with this diff and happy to commit. i'll let it sit a
little in case anyone has an issue (i.e. we've both misunderstood the
text!)

jmc

> - Richard Ulmer
> 
> 
> Index: sndiod.8
> ===
> RCS file: /cvs/src/usr.bin/sndiod/sndiod.8,v
> retrieving revision 1.11
> diff -u -p -u -r1.11 sndiod.8
> --- sndiod.816 Jul 2021 15:05:58 -  1.11
> +++ sndiod.818 Dec 2021 09:42:07 -
> @@ -186,11 +186,11 @@ Examples:
>  .Va u8 , s16le , s24le3 , s24le4lsb .
>  .It Fl F Ar device
>  Specify an alternate device to use.
> -If it doesn't work, the one given with the last
> +If it doesn't work, the one given with the previous
>  .Fl f
>  or
>  .Fl F
> -options will be used.
> +option will be used.
>  For instance, specifying a USB device following a
>  PCI device allows
>  .Nm
>