qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: Thomas Huth <thuth@redhat.com>
To: qemu-devel@nongnu.org, Paolo Bonzini <pbonzini@redhat.com>
Cc: Stefan Hajnoczi <stefanha@redhat.com>,
	Eduardo Habkost <ehabkost@redhat.com>,
	Ben Warren <ben@skyportsystems.com>,
	zhang.zhanghailiang@huawei.com,
	Markus Armbruster <armbru@redhat.com>,
	qemu-trivial@nongnu.org
Subject: [Qemu-devel] [PATCH 3/4] qemu-options: Improve the documentation of '-accel' and '-machine accel=...'
Date: Wed, 13 Jun 2018 07:05:20 +0200	[thread overview]
Message-ID: <1528866321-23886-4-git-send-email-thuth@redhat.com> (raw)
In-Reply-To: <1528866321-23886-1-git-send-email-thuth@redhat.com>

Instead of repeating the same text for both options, let's rather change
the '-machine accel' documentation to point to the preferred '-accel' option
instead.
And in the documenation of the -accel option, make it clear that you can
use colons to specify multiple accelerators.

Signed-off-by: Thomas Huth <thuth@redhat.com>
---
 qemu-options.hx | 20 +++++++++-----------
 1 file changed, 9 insertions(+), 11 deletions(-)

diff --git a/qemu-options.hx b/qemu-options.hx
index 451f7a6..0ec9cac 100644
--- a/qemu-options.hx
+++ b/qemu-options.hx
@@ -30,8 +30,7 @@ ETEXI
 DEF("machine", HAS_ARG, QEMU_OPTION_machine, \
     "-machine [type=]name[,prop[=value][,...]]\n"
     "                selects emulated machine ('-machine help' for list)\n"
-    "                property accel=accel1[:accel2[:...]] selects accelerator\n"
-    "                supported accelerators are kvm, xen, hax, hvf, whpx or tcg (default: tcg)\n"
+    "                property accel=accel1[:accel2[:...]] selects accelerator (see -accel)\n"
     "                kernel_irqchip=on|off|split controls accelerated irqchip support (default=off)\n"
     "                vmport=on|off|auto controls emulation of vmport (default: auto)\n"
     "                kvm_shadow_mem=size of KVM shadow MMU in bytes\n"
@@ -66,10 +65,8 @@ of QEMU will support machine types from many previous versions.
 Supported machine properties are:
 @table @option
 @item accel=@var{accels1}[:@var{accels2}[:...]]
-This is used to enable an accelerator. Depending on the target architecture,
-kvm, xen, hax, hvf, whpx or tcg can be available. By default, tcg is used. If there is
-more than one accelerator specified, the next one is used if the previous one
-fails to initialize.
+This can be used to enable an accelerator. See the preferred @code{-accel}
+option for a list of available accelerators.
 @item kernel_irqchip=on|off
 Controls in-kernel irqchip support for the chosen accelerator when available.
 @item gfx_passthru=on|off
@@ -128,16 +125,17 @@ Select CPU model (@code{-cpu help} for list and additional feature selection)
 ETEXI
 
 DEF("accel", HAS_ARG, QEMU_OPTION_accel,
-    "-accel [accel=]accelerator[,thread=single|multi]\n"
+    "-accel [accel=]accelerator[:accelerator[:...]][,thread=single|multi]\n"
     "                select accelerator (kvm, xen, hax, hvf, whpx 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
 This is used to enable an accelerator. Depending on the target architecture,
-kvm, xen, hax, hvf, whpx or tcg can be available. By default, tcg is used. If there is
-more than one accelerator specified, the next one is used if the previous one
-fails to initialize.
+kvm, xen, hax, hvf, whpx or tcg can be available. By default, tcg is used.
+Multiple accelerators can be specified by separating them with a colon. If
+there is more than one accelerator specified, the next one is used if the
+previous one fails to initialize.
 @table @option
 @item thread=single|multi
 Controls number of TCG threads. When the TCG is multi-threaded there will be one
-- 
1.8.3.1

  parent reply	other threads:[~2018-06-13  5:05 UTC|newest]

Thread overview: 46+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-06-13  5:05 [Qemu-devel] [PATCH 0/4] Clean up accelerator options Thomas Huth
2018-06-13  5:05 ` [Qemu-devel] [PATCH 1/4] Replace '-machine accel=xyz' with '-accel xyz' Thomas Huth
2018-06-13 12:20   ` Eric Blake
2018-06-13 12:48   ` Paolo Bonzini
2018-06-13 12:53     ` Thomas Huth
2018-06-13 13:54       ` Paolo Bonzini
2018-06-13 14:12         ` Thomas Huth
2018-06-13 16:10       ` Eduardo Habkost
2018-06-13 13:38   ` Stefan Hajnoczi
2018-06-13  5:05 ` [Qemu-devel] [PATCH 2/4] Replace '-enable-kvm' with '-accel kvm' in docs and help texts Thomas Huth
2018-06-13 12:51   ` Paolo Bonzini
2018-06-13 13:38   ` Stefan Hajnoczi
2018-06-13  5:05 ` Thomas Huth [this message]
2018-06-13 13:38   ` [Qemu-devel] [PATCH 3/4] qemu-options: Improve the documentation of '-accel' and '-machine accel=...' Stefan Hajnoczi
2018-06-13  5:05 ` [Qemu-devel] [RFC PATCH 4/4] qemu-options: Do not show -enable-kvm and -enable-hax in the docs anymore Thomas Huth
2018-06-13 12:51   ` Paolo Bonzini
2018-06-13 13:38   ` Stefan Hajnoczi
2018-06-13 13:44     ` Daniel P. Berrangé
2018-06-13 15:11       ` Thomas Huth
2018-06-13 15:19         ` Daniel P. Berrangé
2018-06-13 15:44           ` Thomas Huth
2018-06-13 16:02           ` Markus Armbruster
2018-06-19 15:15             ` Cornelia Huck
2018-06-19 16:16               ` Paolo Bonzini
2018-06-22 18:11                 ` Eduardo Habkost
2018-06-22 19:19                   ` Thomas Huth
2018-06-22 19:35                     ` Eduardo Habkost
2018-06-22 21:22                       ` Paolo Bonzini
2018-06-25  6:50                         ` Markus Armbruster
2018-06-25 10:28                           ` Paolo Bonzini
2018-06-25 17:30                             ` Eduardo Habkost
2018-06-25 18:26                               ` Paolo Bonzini
2018-06-25 19:51                                 ` Eduardo Habkost
2018-06-26  5:57                                   ` Paolo Bonzini
2018-06-26 12:29                                     ` Eduardo Habkost
2018-06-26 13:05                                       ` Paolo Bonzini
2018-06-26 16:06                                         ` Eduardo Habkost
2018-06-26 16:10                                           ` Daniel P. Berrangé
2018-06-27  8:39                                           ` Paolo Bonzini
2018-06-27 14:05                                             ` Eduardo Habkost
2018-06-26  4:40                                 ` Thomas Huth
2018-06-26  7:50                                   ` Cornelia Huck
2018-06-26 12:56                                     ` Eduardo Habkost
2018-06-26 16:43                                       ` Markus Armbruster
2018-06-27  8:49                                         ` Paolo Bonzini
2018-06-13 13:39 ` [Qemu-devel] [PATCH 0/4] Clean up accelerator options Stefan Hajnoczi

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1528866321-23886-4-git-send-email-thuth@redhat.com \
    --to=thuth@redhat.com \
    --cc=armbru@redhat.com \
    --cc=ben@skyportsystems.com \
    --cc=ehabkost@redhat.com \
    --cc=pbonzini@redhat.com \
    --cc=qemu-devel@nongnu.org \
    --cc=qemu-trivial@nongnu.org \
    --cc=stefanha@redhat.com \
    --cc=zhang.zhanghailiang@huawei.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).