Re: [Xen-devel] [PATCH] xl.cfg: document the maxmem= option

[Ian Campbell <Ian.Campbell@xxxxxxxxxx>]

On Thu, 2012-05-31 at 16:04 +0100, Olaf Hering wrote:
> # HG changeset patch
> # User Olaf Hering <olaf@xxxxxxxxx>
> # Date 1338476618 -7200
> # Node ID 4dad9647a0963a2665ccf055492e740c2b399517
> # Parent  d7318231cfe3498947bf75f09d6675407d7b4e76
> xl.cfg: document the maxmem= option
> 
> Signed-off-by: Olaf Hering <olaf@xxxxxxxxx>
> 
> diff -r d7318231cfe3 -r 4dad9647a096 docs/man/xl.cfg.pod.5
> --- a/docs/man/xl.cfg.pod.5
> +++ b/docs/man/xl.cfg.pod.5
> @@ -174,6 +174,14 @@ Honoured by the sedf scheduler.
>  
>  Start the guest with MBYTES megabytes of RAM.
>  
> +=item B<maxmem=MBYTES>
> +
> +Specifies the maximum amount of memory a guest can ever see.
> +The value of maxmem= must be equal or greater than memory=.
> +In combination with the memory= option it will start the guest 
> "pre-ballooned".
> +In a HVM guest it will enable the PoD (populate on demand) mode, iff the 
> values of memory= and maxmem= differ.
> +The guest needs a balloon driver in this case, without a balloon driver it 
> will crash.

"iff" has proven to be confusing in the past (we keep getting "fix typo"
patches for existing ones) maybe just spell it out? Otherwise Ack on the
text. Although may add a note that booting a PV guest "pre-ballooned"
Just Works?

Formatting wise some of these lines are very long. Can you wrap to 80
columns please.

Also why have you wrapped this as one sentence per line rather than
wrapping it as paragraphs (which should have blank lines between them)?

I think maxmem= should be B<maxmem=> and the same for memory=.

Ian.

> +
>  =item B<on_poweroff="ACTION">
>  
>  Specifies what should be done with the domain if it shuts itself down.
> @@ -971,10 +979,6 @@ XXX
>  
>  XXX
>  
> -=item B<maxmem=NUMBER>
> -
> -XXX
> -
>  =item B<nodes=XXX>
>  
>  XXX
> 
> _______________________________________________
> Xen-devel mailing list
> Xen-devel@xxxxxxxxxxxxx
> http://lists.xen.org/xen-devel



_______________________________________________
Xen-devel mailing list
Xen-devel@xxxxxxxxxxxxx
http://lists.xen.org/xen-devel