summary refs log tree commit diff stats
path: root/docs/system
diff options
context:
space:
mode:
authorPaolo Bonzini <pbonzini@redhat.com>2020-11-09 04:13:39 -0500
committerPaolo Bonzini <pbonzini@redhat.com>2021-01-23 15:55:08 -0500
commitccd3b3b8112b670fdccf8a392b8419b173ffccb4 (patch)
tree71b7cbf1741f102e3db7532de3de7156dad4efad /docs/system
parentafd736252f106ec54734d4e412220a978f668430 (diff)
downloadfocaccia-qemu-ccd3b3b8112b670fdccf8a392b8419b173ffccb4.tar.gz
focaccia-qemu-ccd3b3b8112b670fdccf8a392b8419b173ffccb4.zip
qemu-option: warn for short-form boolean options
Options such as "server" or "nowait", that are commonly found in -chardev,
are sugar for "server=on" and "wait=off".  This is quite surprising and
also does not have any notion of typing attached.  It is even possible to
do "-device e1000,noid" and get a device with "id=off".

Deprecate it and print a warning when it is encountered.  In general,
this short form for boolean options only seems to be in wide use for
-chardev and -spice.

Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
Diffstat (limited to 'docs/system')
-rw-r--r--docs/system/deprecated.rst6
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/system/deprecated.rst b/docs/system/deprecated.rst
index 651182b2df..9de663526a 100644
--- a/docs/system/deprecated.rst
+++ b/docs/system/deprecated.rst
@@ -127,6 +127,12 @@ Drives with interface types other than ``if=none`` are for onboard
 devices.  It is possible to use drives the board doesn't pick up with
 -device.  This usage is now deprecated.  Use ``if=none`` instead.
 
+Short-form boolean options (since 6.0)
+''''''''''''''''''''''''''''''''''''''
+
+Boolean options such as ``share=on``/``share=off`` could be written
+in short form as ``share`` and ``noshare``.  This is now deprecated
+and will cause a warning.
 
 QEMU Machine Protocol (QMP) commands
 ------------------------------------