diff mbox series

Deprecate the -enable-hax option

Message ID 1529950933-28347-1-git-send-email-thuth@redhat.com
State New
Headers show
Series Deprecate the -enable-hax option | expand

Commit Message

Thomas Huth June 25, 2018, 6:22 p.m. UTC
We currently have got three ways of turning on the HAX accelerator:
"-machine accel=hax", "-accel hax" and "-enable-hax". That's really
confusing and overloaded. Since "-accel" is our preferred way to enable
an accelerator nowadays, and "-accel hax" is even less to type than
"-enable-hax", let's deprecate the "-enable-hax" option now.

Note: While "-enable-kvm" is available since a long time and can hardly be
removed since it is used in a lot of upper layer tools and scripts, the
"-enable-hax" option is still rather new and not very widespread yet, so
I think that it should be OK if we remove this in a couple of releases again
(we'll see whether someone complains after seeing the deprecation message -
then we could still reconsider to keep it if there a well-founded reasons).

Signed-off-by: Thomas Huth <thuth@redhat.com>
---
 Let's give this a try at least :-)

 qemu-doc.texi   | 4 ++++
 qemu-options.hx | 2 +-
 vl.c            | 1 +
 3 files changed, 6 insertions(+), 1 deletion(-)

Comments

Paolo Bonzini June 25, 2018, 6:28 p.m. UTC | #1
On 25/06/2018 20:22, Thomas Huth wrote:
> We currently have got three ways of turning on the HAX accelerator:
> "-machine accel=hax", "-accel hax" and "-enable-hax". That's really
> confusing and overloaded. Since "-accel" is our preferred way to enable
> an accelerator nowadays, and "-accel hax" is even less to type than
> "-enable-hax", let's deprecate the "-enable-hax" option now.
> 
> Note: While "-enable-kvm" is available since a long time and can hardly be
> removed since it is used in a lot of upper layer tools and scripts, the
> "-enable-hax" option is still rather new and not very widespread yet, so
> I think that it should be OK if we remove this in a couple of releases again
> (we'll see whether someone complains after seeing the deprecation message -
> then we could still reconsider to keep it if there a well-founded reasons).
> 
> Signed-off-by: Thomas Huth <thuth@redhat.com>
> ---
>  Let's give this a try at least :-)

Sounds good, queued.

Paolo
Stefan Weil June 25, 2018, 6:50 p.m. UTC | #2
Am 25.06.2018 um 20:28 schrieb Paolo Bonzini:
> On 25/06/2018 20:22, Thomas Huth wrote:
>> We currently have got three ways of turning on the HAX accelerator:
>> "-machine accel=hax", "-accel hax" and "-enable-hax". That's really
>> confusing and overloaded. Since "-accel" is our preferred way to enable
>> an accelerator nowadays, and "-accel hax" is even less to type than
>> "-enable-hax", let's deprecate the "-enable-hax" option now.
>>
>> Note: While "-enable-kvm" is available since a long time and can hardly be
>> removed since it is used in a lot of upper layer tools and scripts, the
>> "-enable-hax" option is still rather new and not very widespread yet, so
>> I think that it should be OK if we remove this in a couple of releases again
>> (we'll see whether someone complains after seeing the deprecation message -
>> then we could still reconsider to keep it if there a well-founded reasons).
>>
>> Signed-off-by: Thomas Huth <thuth@redhat.com>
>> ---
>>  Let's give this a try at least :-)
> 
> Sounds good, queued.
> 
> Paolo
> 

Reviewed-by: Stefan Weil <sw@weilnetz.de>

I would not mind if --enable-hax were removed soon, as I don't think it
was widely used.

Stefan
diff mbox series

Patch

diff --git a/qemu-doc.texi b/qemu-doc.texi
index 16fcb47..ac5ca34 100644
--- a/qemu-doc.texi
+++ b/qemu-doc.texi
@@ -2912,6 +2912,10 @@  Option @option{-virtioconsole} has been replaced by
 The @code{-clock} option is ignored since QEMU version 1.7.0. There is no
 replacement since it is not needed anymore.
 
+@subsection -enable-hax (since 3.0.0)
+
+The @option{-enable-hax} option has been replaced by @option{-accel hax}.
+
 @section QEMU Machine Protocol (QMP) commands
 
 @subsection block-dirty-bitmap-add "autoload" parameter (since 2.12.0)
diff --git a/qemu-options.hx b/qemu-options.hx
index d5b0c26..d811072 100644
--- a/qemu-options.hx
+++ b/qemu-options.hx
@@ -3421,7 +3421,7 @@  STEXI
 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.
+KVM. This option is deprecated, use @option{-accel hax} instead.
 ETEXI
 
 DEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid,
diff --git a/vl.c b/vl.c
index 5d8a9df..c13d589 100644
--- a/vl.c
+++ b/vl.c
@@ -3581,6 +3581,7 @@  int main(int argc, char **argv, char **envp)
                 qemu_opts_parse_noisily(olist, "accel=kvm", false);
                 break;
             case QEMU_OPTION_enable_hax:
+                warn_report("Option is deprecated, use '-accel hax' instead");
                 olist = qemu_find_opts("machine");
                 qemu_opts_parse_noisily(olist, "accel=hax", false);
                 break;