On Sun, Mar 17, 2019 at 01:07:23AM +0100, Klemens Nanni wrote:
> On Sat, Mar 16, 2019 at 11:41:02PM +0000, Jason McIntyre wrote:
> > i don;t understand why you special case "id" in a separate paragraph.
> Specifying an ID is valid only if you want to start an existing VM.
> You cannot create new VMs using a numerical name, that is an ID. This
> limitation is the point I wanted to clarify in the first place.
>
> Without the separate paragraph, this information is lost and `id | name'
> could just be `id' again. But as shown in one of my previous mails,
> something like `vmctl start 60 ...' to create a new VM called "60" is
> not possible and leads to non-obvious errors, hence my attempt to
> differentiate between those cases.
>
> > just document "name" and "id" as normal arguments.
> That's what I just did, no?
>
> > 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.
> Sure.
>
ah, i missed the distinction also. in that case i'm fine with the diff.
i would suggest one tweak, but it's up to you to decide if it reads
better.
> +Start a new VM
> +.Ar name
> +with the specified parameters.
> +An existing VM may be referenced by its
> +.Ar id .
i'd be tempted to phrase it:
Start a new VM
.Ar name
with the specified parameters.
An existing VM may be started by referencing its
.Ar id .
jmc