On Sun, Mar 17, 2019 at 12:21:32AM +0100, Klemens Nanni wrote:
> On Sat, Mar 16, 2019 at 10:22:14PM +0000, Jason McIntyre wrote:
> > i think more properly we should show
> > 
> >     -t id | name
> It's about referencing the VM to be started itself, not templates.
> `-t id' is not possible.
> 

ah, i thought this was -t we were discussing.

> But you pointed out how my addition would errornously imply that, so
> change the `start' synopsis from `name' to `id | name' as well as the
> command description to differentiate between both cases.
> 

i don;t understand why you special case "id" in a separate paragraph.
just document "name" and "id" as normal arguments.

> "Starts" to "Start" while here.
> 

within the "start" command it would be consistent,  but within the page
less so. i think this should be fixed wholesale, in a separate diff.

> Is that clearer?
> 
> Index: usr.sbin/vmctl/vmctl.8
> ===================================================================
> RCS file: /cvs/src/usr.sbin/vmctl/vmctl.8,v
> retrieving revision 1.61
> diff -u -p -r1.61 vmctl.8
> --- usr.sbin/vmctl/vmctl.8    7 Mar 2019 18:54:05 -0000       1.61
> +++ usr.sbin/vmctl/vmctl.8    16 Mar 2019 23:06:31 -0000
> @@ -144,7 +144,7 @@ under the same path.
>  An alias for the
>  .Cm status
>  command.
> -.It Xo Cm start Ar name
> +.It Xo Cm start Ar id | name
>  .Op Fl cL
>  .Bk -words
>  .Op Fl B Ar device
> @@ -157,7 +157,11 @@ command.
>  .Op Fl t Ar name
>  .Ek
>  .Xc
> -Starts a VM defined by the specified name and parameters:
> +Start a new VM
> +.Ar name
> +with the specified parameters.
> +An existing VM may be referenced by its
> +.Ar id .
>  .Bl -tag -width "-I parent"
>  .It Fl B Ar device
>  Force system to boot from the specified device for this boot.
> Index: usr.sbin/vmctl/main.c
> ===================================================================
> RCS file: /cvs/src/usr.sbin/vmctl/main.c,v
> retrieving revision 1.54
> diff -u -p -r1.54 main.c
> --- usr.sbin/vmctl/main.c     1 Mar 2019 12:47:36 -0000       1.54
> +++ usr.sbin/vmctl/main.c     16 Mar 2019 22:42:24 -0000
> @@ -81,7 +81,7 @@ struct ctl_command ctl_commands[] = {
>       { "reset",      CMD_RESET,      ctl_reset,      "[all | switches | 
> vms]" },
>       { "send",       CMD_SEND,       ctl_send,       "id",   1},
>       { "show",       CMD_STATUS,     ctl_status,     "[id]" },
> -     { "start",      CMD_START,      ctl_start,      "name"
> +     { "start",      CMD_START,      ctl_start,      "id | name"
>           " [-cL] [-B device] [-b path] [-d disk] [-i count]\n"
>           "\t\t[-m size] [-n switch] [-r path] [-t name]" },
>       { "status",     CMD_STATUS,     ctl_status,     "[id]" },
> 

Reply via email to