[Qemu-devel] [PATCH] help: Add newline to end of thread option help text

[Qemu-devel] [PATCH] help: Add newline to end of thread option help text

[Suraj Jitindar Singh]

The help text for the thread sub option of the accel option is missing
a newline at the end. This is annoying as it makes it hard to see the
help text for the next option.

Add the new line so that the following option help text (-smp) is
displayed on a new line rather on the same line and directly after
the thread help.

Before patch:

-accel [accel=]accelerator[,thread=single|multi]
                select accelerator (kvm, xen, hax or tcg; use 'help' for a list)
                thread=single|multi (enable multi-threaded TCG)-smp [cpus=]n[,maxcpus=cpus][,cores=cores][,threads=threads][,sockets=sockets]
                set the number of CPUs to 'n' [default=1]
                maxcpus= maximum number of total cpus, including
                offline CPUs for hotplug, etc
                cores= number of CPU cores on one socket
                threads= number of threads on one CPU core
                sockets= number of discrete sockets in the system

After patch:

-accel [accel=]accelerator[,thread=single|multi]
                select accelerator (kvm, xen, hax or tcg; use 'help' for a list)
                thread=single|multi (enable multi-threaded TCG)
-smp [cpus=]n[,maxcpus=cpus][,cores=cores][,threads=threads][,sockets=sockets]
                set the number of CPUs to 'n' [default=1]
                maxcpus= maximum number of total cpus, including
                offline CPUs for hotplug, etc
                cores= number of CPU cores on one socket
                threads= number of threads on one CPU core
                sockets= number of discrete sockets in the system

Signed-off-by: Suraj Jitindar Singh <sjitindarsingh@gmail.com>
---
 qemu-options.hx | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/qemu-options.hx b/qemu-options.hx
index a6c9b9e..8515db8 100644
--- a/qemu-options.hx
+++ b/qemu-options.hx
@@ -102,7 +102,7 @@ ETEXI
 DEF("accel", HAS_ARG, QEMU_OPTION_accel,
     "-accel [accel=]accelerator[,thread=single|multi]\n"
     "                select accelerator (kvm, xen, hax or tcg; use 'help' for a list)\n"
-    "                thread=single|multi (enable multi-threaded TCG)", QEMU_ARCH_ALL)
+    "                thread=single|multi (enable multi-threaded TCG)\n", QEMU_ARCH_ALL)
 STEXI
 @item -accel @var{name}[,prop=@var{value}[,...]]
 @findex -accel
-- 
2.9.4

Re: [Qemu-devel] [PATCH] help: Add newline to end of thread option help text

[Markus Armbruster]

Cc: qemu-trivial

Suraj Jitindar Singh <sjitindarsingh@gmail.com> writes:

> The help text for the thread sub option of the accel option is missing
> a newline at the end. This is annoying as it makes it hard to see the
> help text for the next option.
>
> Add the new line so that the following option help text (-smp) is
> displayed on a new line rather on the same line and directly after
> the thread help.
>
> Before patch:
>
> -accel [accel=]accelerator[,thread=single|multi]
>                 select accelerator (kvm, xen, hax or tcg; use 'help' for a list)
>                 thread=single|multi (enable multi-threaded TCG)-smp [cpus=]n[,maxcpus=cpus][,cores=cores][,threads=threads][,sockets=sockets]
>                 set the number of CPUs to 'n' [default=1]
>                 maxcpus= maximum number of total cpus, including
>                 offline CPUs for hotplug, etc
>                 cores= number of CPU cores on one socket
>                 threads= number of threads on one CPU core
>                 sockets= number of discrete sockets in the system
>
> After patch:
>
> -accel [accel=]accelerator[,thread=single|multi]
>                 select accelerator (kvm, xen, hax or tcg; use 'help' for a list)
>                 thread=single|multi (enable multi-threaded TCG)
> -smp [cpus=]n[,maxcpus=cpus][,cores=cores][,threads=threads][,sockets=sockets]
>                 set the number of CPUs to 'n' [default=1]
>                 maxcpus= maximum number of total cpus, including
>                 offline CPUs for hotplug, etc
>                 cores= number of CPU cores on one socket
>                 threads= number of threads on one CPU core
>                 sockets= number of discrete sockets in the system
>
> Signed-off-by: Suraj Jitindar Singh <sjitindarsingh@gmail.com>
> ---
>  qemu-options.hx | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/qemu-options.hx b/qemu-options.hx
> index a6c9b9e..8515db8 100644
> --- a/qemu-options.hx
> +++ b/qemu-options.hx
> @@ -102,7 +102,7 @@ ETEXI
>  DEF("accel", HAS_ARG, QEMU_OPTION_accel,
>      "-accel [accel=]accelerator[,thread=single|multi]\n"
>      "                select accelerator (kvm, xen, hax or tcg; use 'help' for a list)\n"
> -    "                thread=single|multi (enable multi-threaded TCG)", QEMU_ARCH_ALL)
> +    "                thread=single|multi (enable multi-threaded TCG)\n", QEMU_ARCH_ALL)
>  STEXI
>  @item -accel @var{name}[,prop=@var{value}[,...]]
>  @findex -accel

Re: [Qemu-devel] [PATCH] help: Add newline to end of thread option help text

[Michael Tokarev]

31.05.2017 09:11, Suraj Jitindar Singh wrote:
> The help text for the thread sub option of the accel option is missing
> a newline at the end. This is annoying as it makes it hard to see the
> help text for the next option.
..
Applied to -trivial, thanks!

/mjt