[1/2] qemu-options.hx: improve -m description

Add memory hotplug options to the command-line format. Also,
add a complete command-line example and improve description.

Signed-off-by: Luiz Capitulino <lcapitulino@redhat.com>
---
 qemu-options.hx | 23 ++++++++++++++++++-----
 1 file changed, 18 insertions(+), 5 deletions(-)

On Thu, Feb 26, 2015 at 14:49:15 -0500, Luiz Capitulino wrote:
> Add memory hotplug options to the command-line format. Also,
> add a complete command-line example and improve description.
> 
> Signed-off-by: Luiz Capitulino <lcapitulino@redhat.com>
> ---
>  qemu-options.hx | 23 ++++++++++++++++++-----
>  1 file changed, 18 insertions(+), 5 deletions(-)
> 
> diff --git a/qemu-options.hx b/qemu-options.hx
> index 85ca3ad..1634175 100644
> --- a/qemu-options.hx
> +++ b/qemu-options.hx
> @@ -237,12 +237,25 @@ DEF("m", HAS_ARG, QEMU_OPTION_m,
>      "NOTE: Some architectures might enforce a specific granularity\n",
>      QEMU_ARCH_ALL)
>  STEXI
> -@item -m [size=]@var{megs}
> +@item -m [size=]@var{megs}[,slots=n,maxmem=size]
>  @findex -m
> -Set virtual RAM size to @var{megs} megabytes. Default is 128 MiB.  Optionally,
> -a suffix of ``M'' or ``G'' can be used to signify a value in megabytes or
> -gigabytes respectively. Optional pair @var{slots}, @var{maxmem} could be used
> -to set amount of hotluggable memory slots and possible maximum amount of memory.
> +Sets guest startup RAM size to @var{megs} megabytes. Default is 128 MiB.
> +Optionally, a suffix of ``M'' or ``G'' can be used to signify a value in
> +megabytes or gigabytes respectively. Optional pair @var{slots}, @var{maxmem}
> +could be used to set amount of hotpluggable memory slots and maximum amount of
> +memory.
> +
> +For example, the following command-line sets the guest startup RAM size to
> +1GB, creates 3 slots to hotplug additional memory and sets the maximum
> +memory the guest can reach to 4GB:
> +
> +@example
> +qemy-system-i386 -m 1G,slots=3,maxmem=4G
> +@end example
> +
> +If @var{slots} and @var{maxmem} are not specified, memory hotplug won't
> +be enabled and the guest startup RAM will never increase (although it can
> +be decreased with the use of ballooning).
>  ETEXI

It might be also worth noting that maxmem has to be aligned to the page
size. See:
http://lists.gnu.org/archive/html/qemu-devel/2015-01/msg04345.html

(unfortunately it was not merged yet for some reason ...)

Peter

On Mon, 2 Mar 2015 15:50:19 +0100
Peter Krempa <pkrempa@redhat.com> wrote:

> On Thu, Feb 26, 2015 at 14:49:15 -0500, Luiz Capitulino wrote:
> > Add memory hotplug options to the command-line format. Also,
> > add a complete command-line example and improve description.
> > 
> > Signed-off-by: Luiz Capitulino <lcapitulino@redhat.com>
> > ---
> >  qemu-options.hx | 23 ++++++++++++++++++-----
> >  1 file changed, 18 insertions(+), 5 deletions(-)
> > 
> > diff --git a/qemu-options.hx b/qemu-options.hx
> > index 85ca3ad..1634175 100644
> > --- a/qemu-options.hx
> > +++ b/qemu-options.hx
> > @@ -237,12 +237,25 @@ DEF("m", HAS_ARG, QEMU_OPTION_m,
> >      "NOTE: Some architectures might enforce a specific granularity\n",
> >      QEMU_ARCH_ALL)
> >  STEXI
> > -@item -m [size=]@var{megs}
> > +@item -m [size=]@var{megs}[,slots=n,maxmem=size]
> >  @findex -m
> > -Set virtual RAM size to @var{megs} megabytes. Default is 128 MiB.  Optionally,
> > -a suffix of ``M'' or ``G'' can be used to signify a value in megabytes or
> > -gigabytes respectively. Optional pair @var{slots}, @var{maxmem} could be used
> > -to set amount of hotluggable memory slots and possible maximum amount of memory.
> > +Sets guest startup RAM size to @var{megs} megabytes. Default is 128 MiB.
> > +Optionally, a suffix of ``M'' or ``G'' can be used to signify a value in
> > +megabytes or gigabytes respectively. Optional pair @var{slots}, @var{maxmem}
> > +could be used to set amount of hotpluggable memory slots and maximum amount of
> > +memory.
> > +
> > +For example, the following command-line sets the guest startup RAM size to
> > +1GB, creates 3 slots to hotplug additional memory and sets the maximum
> > +memory the guest can reach to 4GB:
> > +
> > +@example
> > +qemy-system-i386 -m 1G,slots=3,maxmem=4G
> > +@end example
> > +
> > +If @var{slots} and @var{maxmem} are not specified, memory hotplug won't
> > +be enabled and the guest startup RAM will never increase (although it can
> > +be decreased with the use of ballooning).
> >  ETEXI
> 
> It might be also worth noting that maxmem has to be aligned to the page
> size. See:
> http://lists.gnu.org/archive/html/qemu-devel/2015-01/msg04345.html
> 
> (unfortunately it was not merged yet for some reason ...)
it wasn't lost, it's in the last (today's) pull req from PCI tree.

> 
> Peter