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

Message ID 1425394046-20064-2-git-send-email-lcapitulino@redhat.com
State New
Headers show

Commit Message

Luiz Capitulino March 3, 2015, 2:47 p.m. UTC
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 | 22 +++++++++++++++++-----
 1 file changed, 17 insertions(+), 5 deletions(-)

Comments

Igor Mammedov March 3, 2015, 3:21 p.m. UTC | #1
On Tue,  3 Mar 2015 09:47:25 -0500
Luiz Capitulino <lcapitulino@redhat.com> 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 | 22 +++++++++++++++++-----
>  1 file changed, 17 insertions(+), 5 deletions(-)
> 
> diff --git a/qemu-options.hx b/qemu-options.hx
> index 85ca3ad..b0345ae 100644
> --- a/qemu-options.hx
> +++ b/qemu-options.hx
> @@ -237,12 +237,24 @@ 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. Note that @var{maxmem} must be aligned to the page size.
> +
> +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
> +qemu-system-x86_64 -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.
>  ETEXI
>  
>  DEF("mem-path", HAS_ARG, QEMU_OPTION_mempath,

Reviewed-by: Igor Mammedov <imammedo@redhat.com>
Paulo Ricardo Paz Vital March 4, 2015, 5 p.m. UTC | #2
On Tue, 2015-03-03 at 09:47 -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 | 22 +++++++++++++++++-----
>  1 file changed, 17 insertions(+), 5 deletions(-)
> 
> diff --git a/qemu-options.hx b/qemu-options.hx
> index 85ca3ad..b0345ae 100644
> --- a/qemu-options.hx
> +++ b/qemu-options.hx
> @@ -237,12 +237,24 @@ 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. Note that @var{maxmem} must be aligned to the page size.
> +
> +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
> +qemu-system-x86_64 -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.
>  ETEXI
>  
>  DEF("mem-path", HAS_ARG, QEMU_OPTION_mempath,


Reviewed-by: Paulo Vital <paulo.vital@profitbricks.com>

Patch
diff mbox

diff --git a/qemu-options.hx b/qemu-options.hx
index 85ca3ad..b0345ae 100644
--- a/qemu-options.hx
+++ b/qemu-options.hx
@@ -237,12 +237,24 @@  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. Note that @var{maxmem} must be aligned to the page size.
+
+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
+qemu-system-x86_64 -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.
 ETEXI
 
 DEF("mem-path", HAS_ARG, QEMU_OPTION_mempath,