On Thu, Aug 25, 2022 at 09:19:09PM +0000, Klemens Nanni wrote:
> -l takes chunks as per the manual, not specials.
> 
> I also think that comma separated lists are marked up overly
> confusing, so reduce it by one level, i.e. turn
>       -l chunk[,chunk[,...]]]
> into
>       -l chunk[,...]]
> 
> Feedback? OK?
> 

hi.

i think the idea of simplifying this is fine.

remember, if you change the formatting in SYNOPSIS you will have to
mirror that in the actual options list too.

personally i would not even attempt to show the optional part and just
rely on the text description to say how multiple items can be given.
the author obviously wanted to show that though.

jmc

> Index: bioctl.8
> ===================================================================
> RCS file: /cvs/src/sbin/bioctl/bioctl.8,v
> retrieving revision 1.109
> diff -u -p -r1.109 bioctl.8
> --- bioctl.8  8 Feb 2021 11:20:03 -0000       1.109
> +++ bioctl.8  25 Aug 2022 21:11:23 -0000
> @@ -42,10 +42,10 @@
>  .Pp
>  .Nm bioctl
>  .Op Fl dhiPqsv
> -.Op Fl C Ar flag Ns Op Pf , Ar flag Ns Op Pf , Ar ...
> +.Op Fl C Ar flag Ns Op Pf , Ar ...
>  .Op Fl c Ar raidlevel
>  .Op Fl k Ar keydisk
> -.Op Fl l Ar chunk Ns Op Pf , Ar chunk Ns Op Pf , Ar ...
> +.Op Fl l Ar chunk Ns Op Pf , Ar ...
>  .Op Fl O Ar chunk | channel : Ns Ar target Ns Op Pf . Ar lun
>  .Op Fl p Ar passfile
>  .Op Fl R Ar chunk | channel : Ns Ar target Ns Op Pf . Ar lun
> Index: bioctl.c
> ===================================================================
> RCS file: /cvs/src/sbin/bioctl/bioctl.c,v
> retrieving revision 1.148
> diff -u -p -r1.148 bioctl.c
> --- bioctl.c  19 Aug 2022 17:49:10 -0000      1.148
> +++ bioctl.c  25 Aug 2022 21:16:01 -0000
> @@ -290,8 +290,8 @@ usage(void)
>               "[-u channel:target[.lun]] "
>               "device\n"
>               "       %s [-dhiPqsv] "
> -             "[-C flag[,flag,...]] [-c raidlevel] [-k keydisk]\n"
> -             "\t[-l special[,special,...]] "
> +             "[-C flag[,...]] [-c raidlevel] [-k keydisk]\n"
> +             "\t[-l chunk[,...]] "
>               "[-O device | channel:target[.lun]]\n"
>               "\t[-p passfile] [-R chunk | channel:target[.lun]]\n"
>               "\t[-r rounds] "
> 

Reply via email to