Re: [PATCH] docs: clarify xl mem-max semantics

[Juergen Gross <jgross@suse.com>]

On 21/01/17 00:15, Jim Fehlig wrote:
> On 01/20/2017 02:54 AM, Juergen Gross wrote:
>> The information given in the xl man page for the mem-max command is
>> rather brief. Expand it in order to let the reader understand what it
>> is really doing.
>>
>> As the related libxl function libxl_domain_setmaxmem() isn't much
>> clearer add a comment to it explaining the desired semantics.
>>
>> Signed-off-by: Juergen Gross <jgross@suse.com>
>> ---
>>  docs/man/xl.pod.1.in | 10 ++++++++++
>>  tools/libxl/libxl.c  |  6 ++++++
>>  2 files changed, 16 insertions(+)
>>
>> diff --git a/docs/man/xl.pod.1.in b/docs/man/xl.pod.1.in
>> index 09c1faa..62307e8 100644
>> --- a/docs/man/xl.pod.1.in
>> +++ b/docs/man/xl.pod.1.in
>> @@ -401,6 +401,16 @@ for bytes.
>>  The mem-max value may not correspond to the actual memory used in the
>>  domain, as it may balloon down its memory to give more back to the OS.
>>
>> +The value given just sets the memory amount the domain is allowed to
>> allocate
>> +in the hypervisor. Thus it can't be lower than the current
>> reservation, but
>> +it is allowed to be higher than the configured maximum memory size of
>> the
>> +domain (B<maxmem> parameter in the domain's configuration). Setting the
>> +allowed memory size via B<xl mem-max> above the B<maxmem> size won't
>> let use
>> +this value to be used for B<xl mem-set>, as B<xl mem-set> will still use
>> +B<maxmem> as an upper limit.
> 
> I find the last sentence a bit awkward. Might I suggest
> 
> Using B<xl mem-max> to set the maximum memory above the initial
> B<maxmem> value will not allow the additional memory to be used via B<xl
> mem-set>. The initial B<maxmem> value is still used as an upper limit
> for B<xl mem-set>.

Yes, this is better.


Thanks,

Juergen

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