All of lore.kernel.org
 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-trivial] [RFC PATCH 4/4] qemu-options: Do not show -enable-kvm and -enable-hax in the docs anymore
Date: Wed, 13 Jun 2018 07:05:21 +0200	[thread overview]
Message-ID: <1528866321-23886-5-git-send-email-thuth@redhat.com> (raw)
In-Reply-To: <1528866321-23886-1-git-send-email-thuth@redhat.com>

We've got three ways of enabling an accelerator: -machine accel=xyz,
-accel xyz and -enable-xyz. For new QEMU users, this must be very
confusing ("Which one do I have to use? Is there a difference between
the options?"). While -enable-kvm was useful in the past, there is no
real good reason for using it anymore today ("-accel kvm" is even less
to type than "-enable-kvm"), so let's decrease the confusing amount of
options in our documenation a little bit by removing the -enable-xyz
here. Note that the option itself is neither removed nor marked as
deprecated - since -enable-kvm is likely used in a lot of scripts and
since its code is easy to maintain, we should keep it around to avoid
to break old setups.

Signed-off-by: Thomas Huth <thuth@redhat.com>
---
 PS: I guess Paolo won't like this patch ... let's try it anyway ;-)

 qemu-options.hx | 22 ++++------------------
 1 file changed, 4 insertions(+), 18 deletions(-)

diff --git a/qemu-options.hx b/qemu-options.hx
index 0ec9cac..f33a81e 100644
--- a/qemu-options.hx
+++ b/qemu-options.hx
@@ -3414,25 +3414,11 @@ STEXI
 Set the filename for the BIOS.
 ETEXI
 
-DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \
-    "-enable-kvm     enable KVM full virtualization support\n", QEMU_ARCH_ALL)
-STEXI
-@item -enable-kvm
-@findex -enable-kvm
-Enable KVM full virtualization support. This option is only available
-if KVM support is enabled when compiling.
-ETEXI
+HXCOMM -accel kvm should be used instead, thus this is not documented anymore
+DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, "", QEMU_ARCH_ALL)
 
-DEF("enable-hax", 0, QEMU_OPTION_enable_hax, \
-    "-enable-hax     enable HAX virtualization support\n", QEMU_ARCH_I386)
-STEXI
-@item -enable-hax
-@findex -enable-hax
-Enable HAX (Hardware-based Acceleration eXecution) support. This option
-is only available if HAX support is enabled when compiling. HAX is only
-applicable to MAC and Windows platform, and thus does not conflict with
-KVM.
-ETEXI
+HXCOMM -accel hax should be used instead, thus this is not documented anymore
+DEF("enable-hax", 0, QEMU_OPTION_enable_hax, "", QEMU_ARCH_I386)
 
 DEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid,
     "-xen-domid id   specify xen guest domain id\n", QEMU_ARCH_ALL)
-- 
1.8.3.1



WARNING: multiple messages have this Message-ID (diff)
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] [RFC PATCH 4/4] qemu-options: Do not show -enable-kvm and -enable-hax in the docs anymore
Date: Wed, 13 Jun 2018 07:05:21 +0200	[thread overview]
Message-ID: <1528866321-23886-5-git-send-email-thuth@redhat.com> (raw)
In-Reply-To: <1528866321-23886-1-git-send-email-thuth@redhat.com>

We've got three ways of enabling an accelerator: -machine accel=xyz,
-accel xyz and -enable-xyz. For new QEMU users, this must be very
confusing ("Which one do I have to use? Is there a difference between
the options?"). While -enable-kvm was useful in the past, there is no
real good reason for using it anymore today ("-accel kvm" is even less
to type than "-enable-kvm"), so let's decrease the confusing amount of
options in our documenation a little bit by removing the -enable-xyz
here. Note that the option itself is neither removed nor marked as
deprecated - since -enable-kvm is likely used in a lot of scripts and
since its code is easy to maintain, we should keep it around to avoid
to break old setups.

Signed-off-by: Thomas Huth <thuth@redhat.com>
---
 PS: I guess Paolo won't like this patch ... let's try it anyway ;-)

 qemu-options.hx | 22 ++++------------------
 1 file changed, 4 insertions(+), 18 deletions(-)

diff --git a/qemu-options.hx b/qemu-options.hx
index 0ec9cac..f33a81e 100644
--- a/qemu-options.hx
+++ b/qemu-options.hx
@@ -3414,25 +3414,11 @@ STEXI
 Set the filename for the BIOS.
 ETEXI
 
-DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \
-    "-enable-kvm     enable KVM full virtualization support\n", QEMU_ARCH_ALL)
-STEXI
-@item -enable-kvm
-@findex -enable-kvm
-Enable KVM full virtualization support. This option is only available
-if KVM support is enabled when compiling.
-ETEXI
+HXCOMM -accel kvm should be used instead, thus this is not documented anymore
+DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, "", QEMU_ARCH_ALL)
 
-DEF("enable-hax", 0, QEMU_OPTION_enable_hax, \
-    "-enable-hax     enable HAX virtualization support\n", QEMU_ARCH_I386)
-STEXI
-@item -enable-hax
-@findex -enable-hax
-Enable HAX (Hardware-based Acceleration eXecution) support. This option
-is only available if HAX support is enabled when compiling. HAX is only
-applicable to MAC and Windows platform, and thus does not conflict with
-KVM.
-ETEXI
+HXCOMM -accel hax should be used instead, thus this is not documented anymore
+DEF("enable-hax", 0, QEMU_OPTION_enable_hax, "", QEMU_ARCH_I386)
 
 DEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid,
     "-xen-domid id   specify xen guest domain id\n", QEMU_ARCH_ALL)
-- 
1.8.3.1

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

Thread overview: 92+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-06-13  5:05 [Qemu-trivial] [PATCH 0/4] Clean up accelerator options Thomas Huth
2018-06-13  5:05 ` [Qemu-devel] " Thomas Huth
2018-06-13  5:05 ` [Qemu-trivial] [PATCH 1/4] Replace '-machine accel=xyz' with '-accel xyz' Thomas Huth
2018-06-13  5:05   ` [Qemu-devel] " Thomas Huth
2018-06-13 12:20   ` [Qemu-trivial] " Eric Blake
2018-06-13 12:20     ` Eric Blake
2018-06-13 12:48   ` [Qemu-trivial] " Paolo Bonzini
2018-06-13 12:48     ` [Qemu-devel] " Paolo Bonzini
2018-06-13 12:53     ` [Qemu-trivial] " Thomas Huth
2018-06-13 12:53       ` [Qemu-devel] " Thomas Huth
2018-06-13 13:54       ` [Qemu-trivial] " Paolo Bonzini
2018-06-13 13:54         ` [Qemu-devel] " Paolo Bonzini
2018-06-13 14:12         ` [Qemu-trivial] " Thomas Huth
2018-06-13 14:12           ` Thomas Huth
2018-06-13 16:10       ` [Qemu-trivial] " Eduardo Habkost
2018-06-13 16:10         ` [Qemu-devel] " Eduardo Habkost
2018-06-13 13:38   ` [Qemu-trivial] " Stefan Hajnoczi
2018-06-13 13:38     ` [Qemu-devel] " Stefan Hajnoczi
2018-06-13  5:05 ` [Qemu-trivial] [PATCH 2/4] Replace '-enable-kvm' with '-accel kvm' in docs and help texts Thomas Huth
2018-06-13  5:05   ` [Qemu-devel] " Thomas Huth
2018-06-13 12:51   ` [Qemu-trivial] " Paolo Bonzini
2018-06-13 12:51     ` [Qemu-devel] " Paolo Bonzini
2018-06-13 13:38   ` [Qemu-trivial] " Stefan Hajnoczi
2018-06-13 13:38     ` [Qemu-devel] " Stefan Hajnoczi
2018-06-13  5:05 ` [Qemu-trivial] [PATCH 3/4] qemu-options: Improve the documentation of '-accel' and '-machine accel=...' Thomas Huth
2018-06-13  5:05   ` [Qemu-devel] " Thomas Huth
2018-06-13 13:38   ` [Qemu-trivial] " Stefan Hajnoczi
2018-06-13 13:38     ` [Qemu-devel] " Stefan Hajnoczi
2018-06-13  5:05 ` Thomas Huth [this message]
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   ` [Qemu-trivial] " Paolo Bonzini
2018-06-13 12:51     ` [Qemu-devel] " Paolo Bonzini
2018-06-13 13:38   ` [Qemu-trivial] " Stefan Hajnoczi
2018-06-13 13:38     ` [Qemu-devel] " Stefan Hajnoczi
2018-06-13 13:44     ` [Qemu-trivial] " Daniel P. Berrangé
2018-06-13 13:44       ` Daniel P. Berrangé
2018-06-13 15:11       ` [Qemu-trivial] " Thomas Huth
2018-06-13 15:11         ` Thomas Huth
2018-06-13 15:19         ` [Qemu-trivial] " Daniel P. Berrangé
2018-06-13 15:19           ` Daniel P. Berrangé
2018-06-13 15:44           ` [Qemu-trivial] " Thomas Huth
2018-06-13 15:44             ` Thomas Huth
2018-06-13 16:02           ` [Qemu-trivial] " Markus Armbruster
2018-06-13 16:02             ` Markus Armbruster
2018-06-19 15:15             ` [Qemu-trivial] " Cornelia Huck
2018-06-19 15:15               ` Cornelia Huck
2018-06-19 16:16               ` [Qemu-trivial] " Paolo Bonzini
2018-06-19 16:16                 ` Paolo Bonzini
2018-06-22 18:11                 ` [Qemu-trivial] " Eduardo Habkost
2018-06-22 18:11                   ` Eduardo Habkost
2018-06-22 19:19                   ` [Qemu-trivial] " Thomas Huth
2018-06-22 19:19                     ` Thomas Huth
2018-06-22 19:35                     ` [Qemu-trivial] " Eduardo Habkost
2018-06-22 19:35                       ` Eduardo Habkost
2018-06-22 21:22                       ` [Qemu-trivial] " Paolo Bonzini
2018-06-22 21:22                         ` Paolo Bonzini
2018-06-25  6:50                         ` [Qemu-trivial] " Markus Armbruster
2018-06-25  6:50                           ` Markus Armbruster
2018-06-25 10:28                           ` [Qemu-trivial] " Paolo Bonzini
2018-06-25 10:28                             ` Paolo Bonzini
2018-06-25 17:30                             ` [Qemu-trivial] " Eduardo Habkost
2018-06-25 17:30                               ` Eduardo Habkost
2018-06-25 18:26                               ` [Qemu-trivial] " Paolo Bonzini
2018-06-25 18:26                                 ` Paolo Bonzini
2018-06-25 19:51                                 ` [Qemu-trivial] " Eduardo Habkost
2018-06-25 19:51                                   ` Eduardo Habkost
2018-06-26  5:57                                   ` [Qemu-trivial] " Paolo Bonzini
2018-06-26  5:57                                     ` Paolo Bonzini
2018-06-26 12:29                                     ` [Qemu-trivial] " Eduardo Habkost
2018-06-26 12:29                                       ` Eduardo Habkost
2018-06-26 13:05                                       ` [Qemu-trivial] " Paolo Bonzini
2018-06-26 13:05                                         ` Paolo Bonzini
2018-06-26 16:06                                         ` [Qemu-trivial] " Eduardo Habkost
2018-06-26 16:06                                           ` Eduardo Habkost
2018-06-26 16:10                                           ` [Qemu-trivial] " Daniel P. Berrangé
2018-06-26 16:10                                             ` Daniel P. Berrangé
2018-06-27  8:39                                           ` [Qemu-trivial] " Paolo Bonzini
2018-06-27  8:39                                             ` Paolo Bonzini
2018-06-27 14:05                                             ` [Qemu-trivial] " Eduardo Habkost
2018-06-27 14:05                                               ` Eduardo Habkost
2018-06-26  4:40                                 ` [Qemu-trivial] " Thomas Huth
2018-06-26  4:40                                   ` Thomas Huth
2018-06-26  7:50                                   ` [Qemu-trivial] " Cornelia Huck
2018-06-26  7:50                                     ` Cornelia Huck
2018-06-26 12:56                                     ` [Qemu-trivial] " Eduardo Habkost
2018-06-26 12:56                                       ` Eduardo Habkost
2018-06-26 16:43                                       ` [Qemu-trivial] " Markus Armbruster
2018-06-26 16:43                                         ` Markus Armbruster
2018-06-27  8:49                                         ` [Qemu-trivial] " Paolo Bonzini
2018-06-27  8:49                                           ` Paolo Bonzini
2018-06-13 13:39 ` [Qemu-trivial] [PATCH 0/4] Clean up accelerator options Stefan Hajnoczi
2018-06-13 13:39   ` [Qemu-devel] " 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-5-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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.