[Qemu-devel] [PATCH] qemu-options.hx: improve -numa doc

[Qemu-devel] [PATCH] qemu-options.hx: improve -numa doc

[Luiz Capitulino]

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>
---
 qemu-options.hx | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

diff --git a/qemu-options.hx b/qemu-options.hx
index 56e5fdf..ed1d409 100644
--- a/qemu-options.hx
+++ b/qemu-options.hx
@@ -97,10 +97,13 @@ 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 @var{mem} and @var{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}
+and -@option{smp} options to respectively allocate RAM and vCPUs.
 ETEXI
 
 DEF("add-fd", HAS_ARG, QEMU_OPTION_add_fd,
-- 
1.8.1.4

Re: [Qemu-devel] [PATCH] qemu-options.hx: improve -numa doc

[Paolo Bonzini]

Il 14/02/2014 20:34, Luiz Capitulino ha scritto:
> 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>
> ---
>  qemu-options.hx | 9 ++++++---
>  1 file changed, 6 insertions(+), 3 deletions(-)
>
> diff --git a/qemu-options.hx b/qemu-options.hx
> index 56e5fdf..ed1d409 100644
> --- a/qemu-options.hx
> +++ b/qemu-options.hx
> @@ -97,10 +97,13 @@ 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 @var{mem} and @var{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}
> +and -@option{smp} options to respectively allocate RAM and vCPUs.
>  ETEXI
>
>  DEF("add-fd", HAS_ARG, QEMU_OPTION_add_fd,
>

Applied to (rebased) NUMA branch.

Paolo