Re: [Xen-devel] [PATCH XenDocDay 03/19] xl.pod.1: improve create documentation

[Ian Campbell <Ian.Campbell@xxxxxxxxxx>]

On Wed, 2011-11-30 at 14:16 +0000, stefano.stabellini@xxxxxxxxxxxxx
wrote:
> From: Stefano Stabellini <stefano.stabellini@xxxxxxxxxxxxx>
> 
> Signed-off-by: Stefano Stabellini <stefano.stabellini@xxxxxxxxxxxxx>
> ---
>  docs/man/xl.pod.1 |   21 +++++++++++++++------
>  1 files changed, 15 insertions(+), 6 deletions(-)
> 
> diff --git a/docs/man/xl.pod.1 b/docs/man/xl.pod.1
> index 426b8e8..8cc9779 100644
> --- a/docs/man/xl.pod.1
> +++ b/docs/man/xl.pod.1
> @@ -52,13 +52,14 @@ previously, most commands take I<domain-id> as the first 
> parameter.
>  
>  =over 4
>  
> -=item B<create> [I<OPTIONS>] I<configfile>
> +=item B<create> [I<configfile>] [I<OPTIONS>]

I think this is actually:

        [I<OPTIONS>] [I<configfile>] [I<config-statements>]

<OPTIONS> are things like -c and -e etc.

<config-statements> are any statement you might write into I<configfile>
and you could even build a guest entirely by passing stuff on the
command line. I'm not sure if there is any ordering constraints, e.g.
I'm not sure if you can mix all these arbitrarily, but the above would
be the natural/normal ordering.

>  
> -The create subcommand requires a config file: see L<xl.cfg(5)> for
> -full details of that file format and possible options.
> +The create subcommand takes a config file as first argument: see
> +L<xl.cfg> for full details of that file format and possible options.
> +If I<configfile> is missing B<XL> creates the domain starting from the
> +default value for every option.

n.b. there is no default for "name" and so it must be given somewhere.

>  
> -I<configfile> can either be an absolute path to a file, or a relative
> -path to a file located in /etc/xen.
> +I<configfile> has to be an absolute path to a file.
>  
>  Create will return B<as soon> as the domain is started.  This B<does
>  not> mean the guest OS in the domain has actually booted, or is
> @@ -88,7 +89,15 @@ Leave the domain paused after it is created.
>  =item B<-c>
>  
>  Attach console to the domain as soon as it has started.  This is
> -useful for determining issues with crashing domains.
> +useful for determining issues with crashing domains and just as a
> +general convenience since you often want to watch the
> +domain boot.
> +
> +=item B<key=value>

Ah, this is what I was calling <config-statements> above.

Ian.

> +
> +It is possible to pass I<key=value> pairs on the command line to provide
> +options as if they were written in the configuration file; these override
> +whatever is in the I<configfile>.
>  
>  =back
>  



_______________________________________________
Xen-devel mailing list
Xen-devel@xxxxxxxxxxxxxxxxxxx
http://lists.xensource.com/xen-devel