On Sat, May 19, 2018 at 03:26:36PM +0200, Klemens Nanni wrote:
> Sort vmctl's usage alphabetically, use "path" instead of "filename",
> "image" or "disk" and "id" instead of "name" as argument name to be
> consistent and in sync with vmctl.8.
>
> Zap a trailing asterisk as well as double qoutes around argument names;
> their inconsistent usage is confusing.
>
> This eventually turns
>
> usage: vmctl command [arg ...]
> vmctl console id
> vmctl create "path" -s size
> vmctl load "path"
> vmctl log (verbose|brief)
> vmctl reload
> vmctl reset [all|vms|switches]
> vmctl show [id]
> vmctl start "name" [-Lc] [-b image] [-r image] [-m size]
> [-n switch] [-i count] [-d disk]*
> vmctl status [id]
> vmctl stop id
> vmctl pause id
> vmctl unpause id
> vmctl send id
> vmctl receive id
>
> into
>
> usage: vmctl command [arg ...]
> vmctl console id
> vmctl create path -s size
> vmctl load path
> vmctl log (brief|verbose)
> vmctl pause id
> vmctl receive id
> vmctl reload
> vmctl reset [all|switches|vms]
> vmctl send id
> vmctl show [id]
> vmctl start id [-cL] [-b path] [-d path] [-i count]
> [-m size] [-n switch] [-r path]
> vmctl status [id]
> vmctl stop id
> vmctl unpause id
>
> Feedback? OK?
>
I think it reads better as it is now.
"path" loses all the contextual clues. "-d path" ... ok, what is that?
is it a path to a disk? is it a path to a debug file? is it a path to
something else starting with "d"? And what does "-b path -d path -r path"
mean, when everything's a "path"?
The trailing asterisk is used to indicate that multiple -d options
can be given.
However now that you point it out, we could probably clarify what -b's
argument is instead of just "image".
I have fewer objections over changing "name" to "id" but if you want to do
that, please go change the 100 other places it's referred to like that
(eg, man pages).
-ml
> Index: main.c
> ===================================================================
> RCS file: /cvs/src/usr.sbin/vmctl/main.c,v
> retrieving revision 1.35
> diff -u -p -r1.35 main.c
> --- main.c 24 Feb 2018 10:39:35 -0000 1.35
> +++ main.c 19 May 2018 13:23:33 -0000
> @@ -63,21 +63,21 @@ int ctl_receive(struct parse_result *,
>
> struct ctl_command ctl_commands[] = {
> { "console", CMD_CONSOLE, ctl_console, "id" },
> - { "create", CMD_CREATE, ctl_create, "\"path\" -s size", 1 },
> - { "load", CMD_LOAD, ctl_load, "\"path\"" },
> - { "log", CMD_LOG, ctl_log, "(verbose|brief)" },
> + { "create", CMD_CREATE, ctl_create, "path -s size", 1 },
> + { "load", CMD_LOAD, ctl_load, "path" },
> + { "log", CMD_LOG, ctl_log, "(brief|verbose)" },
> + { "pause", CMD_PAUSE, ctl_pause, "id" },
> + { "receive", CMD_RECEIVE, ctl_receive, "id", 1},
> { "reload", CMD_RELOAD, ctl_reload, "" },
> - { "reset", CMD_RESET, ctl_reset, "[all|vms|switches]" },
> + { "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\""
> - " [-Lc] [-b image] [-r image] [-m size]\n"
> - "\t\t[-n switch] [-i count] [-d disk]*" },
> + { "start", CMD_START, ctl_start, "id"
> + " [-cL] [-b path] [-d path] [-i count]\n"
> + "\t\t[-m size] [-n switch] [-r path]" },
> { "status", CMD_STATUS, ctl_status, "[id]" },
> { "stop", CMD_STOP, ctl_stop, "id" },
> - { "pause", CMD_PAUSE, ctl_pause, "id" },
> { "unpause", CMD_UNPAUSE, ctl_unpause, "id" },
> - { "send", CMD_SEND, ctl_send, "id", 1},
> - { "receive", CMD_RECEIVE, ctl_receive, "id" , 1},
> { NULL }
> };
>
> Index: vmctl.8
> ===================================================================
> RCS file: /cvs/src/usr.sbin/vmctl/vmctl.8,v
> retrieving revision 1.39
> diff -u -p -r1.39 vmctl.8
> --- vmctl.8 24 Feb 2018 13:14:09 -0000 1.39
> +++ vmctl.8 19 May 2018 12:26:00 -0000
> @@ -56,7 +56,7 @@ Creates a VM disk image file with the sp
> and
> .Ar size ,
> rounded to megabytes.
> -.It Cm load Ar filename
> +.It Cm load Ar path
> Load additional configuration from the specified file.
> .It Cm log brief
> Disable verbose debug logging.
> @@ -65,9 +65,9 @@ Enable verbose debug logging.
> .It Cm pause Ar id
> Pause a VM with the specified
> .Ar id .
> -.It Cm receive Ar name
> +.It Cm receive Ar id
> Receive a VM from standard input and start it with the specified
> -.Ar name .
> +.Ar id .
> .It Cm reload
> Remove all stopped VMs and reload the configuration from the default
> configuration file.
> @@ -85,7 +85,7 @@ to standard output and terminate it.
> An alias for the
> .Cm status
> command.
> -.It Xo Cm start Ar name
> +.It Xo Cm start Ar id
> .Op Fl cL
> .Op Fl b Ar path
> .Op Fl d Ar path
>
