[v3.2,06/31] man: improve -numa doc

From: Luiz Capitulino <lcapitulino@redhat.com>

The -numa option documentation in qemu's manpage lacks the command-line
options and some information regarding how it relates to options -m and
-smp. This commit fills in the missing text.

Signed-off-by: Luiz Capitulino <lcapitulino@redhat.com>
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
Signed-off-by: Hu Tao <hutao@cn.fujitsu.com>
---
 qemu-options.hx | 10 +++++++---
 1 file changed, 7 insertions(+), 3 deletions(-)

On Wed, May 14, 2014 at 05:43:10PM +0800, Hu Tao wrote:
> From: Luiz Capitulino <lcapitulino@redhat.com>
> 
> The -numa option documentation in qemu's manpage lacks the command-line
> options and some information regarding how it relates to options -m and
> -smp. This commit fills in the missing text.
> 
> Signed-off-by: Luiz Capitulino <lcapitulino@redhat.com>
> Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
> Signed-off-by: Hu Tao <hutao@cn.fujitsu.com>

Reviewed-by: Eduardo Habkost <ehabkost@redhat.com>

On Wed, May 14, 2014 at 05:43:10PM +0800, Hu Tao wrote:
> From: Luiz Capitulino <lcapitulino@redhat.com>
> 
> The -numa option documentation in qemu's manpage lacks the command-line
> options and some information regarding how it relates to options -m and
> -smp. This commit fills in the missing text.
> 
> Signed-off-by: Luiz Capitulino <lcapitulino@redhat.com>
> Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
> Signed-off-by: Hu Tao <hutao@cn.fujitsu.com>
> ---
>  qemu-options.hx | 10 +++++++---
>  1 file changed, 7 insertions(+), 3 deletions(-)
> 
> diff --git a/qemu-options.hx b/qemu-options.hx
> index 781af14..c676397 100644
> --- a/qemu-options.hx
> +++ b/qemu-options.hx
> @@ -97,10 +97,14 @@ ETEXI
>  DEF("numa", HAS_ARG, QEMU_OPTION_numa,
>      "-numa node[,mem=size][,cpus=cpu[-cpu]][,nodeid=node]\n", QEMU_ARCH_ALL)
>  STEXI
> -@item -numa @var{opts}
> +@item -numa node[,mem=@var{size}][,cpus=@var{cpu[-cpu]}][,nodeid=@var{node}]
>  @findex -numa
> -Simulate a multi node NUMA system. If mem and cpus are omitted, resources
> -are split equally.
> +Simulate a multi node NUMA system. If @samp{mem}
> +and @samp{cpus} are omitted, resources are split equally. Also, note
> +that the -@option{numa} option doesn't allocate any of the specified
> +resources. That is, it just assigns existing resources to NUMA nodes. This
> +means that one still has to use the @option{-m}, @option{-smp} options
> +to respectively allocate RAM and vCPUs.

to allocate RAM and VCPUs respectively.

>  ETEXI
>  
>  DEF("add-fd", HAS_ARG, QEMU_OPTION_add_fd,
> -- 
> 1.8.5.2.229.g4448466
>

On Sun, Jun 08, 2014 at 01:09:20PM +0300, Michael S. Tsirkin wrote:
> On Wed, May 14, 2014 at 05:43:10PM +0800, Hu Tao wrote:
> > From: Luiz Capitulino <lcapitulino@redhat.com>
> > 
> > The -numa option documentation in qemu's manpage lacks the command-line
> > options and some information regarding how it relates to options -m and
> > -smp. This commit fills in the missing text.
> > 
> > Signed-off-by: Luiz Capitulino <lcapitulino@redhat.com>
> > Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
> > Signed-off-by: Hu Tao <hutao@cn.fujitsu.com>
> > ---
> >  qemu-options.hx | 10 +++++++---
> >  1 file changed, 7 insertions(+), 3 deletions(-)
> > 
> > diff --git a/qemu-options.hx b/qemu-options.hx
> > index 781af14..c676397 100644
> > --- a/qemu-options.hx
> > +++ b/qemu-options.hx
> > @@ -97,10 +97,14 @@ ETEXI
> >  DEF("numa", HAS_ARG, QEMU_OPTION_numa,
> >      "-numa node[,mem=size][,cpus=cpu[-cpu]][,nodeid=node]\n", QEMU_ARCH_ALL)
> >  STEXI
> > -@item -numa @var{opts}
> > +@item -numa node[,mem=@var{size}][,cpus=@var{cpu[-cpu]}][,nodeid=@var{node}]
> >  @findex -numa
> > -Simulate a multi node NUMA system. If mem and cpus are omitted, resources
> > -are split equally.
> > +Simulate a multi node NUMA system. If @samp{mem}
> > +and @samp{cpus} are omitted, resources are split equally. Also, note
> > +that the -@option{numa} option doesn't allocate any of the specified
> > +resources. That is, it just assigns existing resources to NUMA nodes. This
> > +means that one still has to use the @option{-m}, @option{-smp} options
> > +to respectively allocate RAM and vCPUs.
> 
> to allocate RAM and VCPUs respectively.

Thanks.

Hu