net/slirp: Deprecate the [hub_id name] parameter tuple
[qemu.git] / qemu-deprecated.texi
blob9b918f02ec809d0d0cc69db000d83f0f4765fd6a
1 @node Deprecated features
2 @appendix Deprecated features
4 In general features are intended to be supported indefinitely once
5 introduced into QEMU. In the event that a feature needs to be removed,
6 it will be listed in this appendix. The feature will remain functional
7 for 2 releases prior to actual removal. Deprecated features may also
8 generate warnings on the console when QEMU starts up, or if activated
9 via a monitor command, however, this is not a mandatory requirement.
11 Prior to the 2.10.0 release there was no official policy on how
12 long features would be deprecated prior to their removal, nor
13 any documented list of which features were deprecated. Thus
14 any features deprecated prior to 2.10.0 will be treated as if
15 they were first deprecated in the 2.10.0 release.
17 What follows is a list of all features currently marked as
18 deprecated.
20 @section Build options
22 @subsection GTK 2.x
24 Previously QEMU has supported building against both GTK 2.x
25 and 3.x series APIs. Support for the GTK 2.x builds will be
26 discontinued, so maintainers should switch to using GTK 3.x,
27 which is the default.
29 @subsection SDL 1.2
31 Previously QEMU has supported building against both SDL 1.2
32 and 2.0 series APIs. Support for the SDL 1.2 builds will be
33 discontinued, so maintainers should switch to using SDL 2.0,
34 which is the default.
36 @section System emulator command line arguments
38 @subsection -no-kvm (since 1.3.0)
40 The ``-no-kvm'' argument is now a synonym for setting
41 ``-machine accel=tcg''.
43 @subsection -usbdevice (since 2.10.0)
45 The ``-usbdevice DEV'' argument is now a synonym for setting
46 the ``-device usb-DEV'' argument instead. The deprecated syntax
47 would automatically enable USB support on the machine type.
48 If using the new syntax, USB support must be explicitly
49 enabled via the ``-machine usb=on'' argument.
51 @subsection -fsdev handle (since 2.12.0)
53 The ``handle'' fsdev backend does not support symlinks and causes the 9p
54 filesystem in the guest to fail a fair amount of tests from the PJD POSIX
55 filesystem test suite. Also it requires the CAP_DAC_READ_SEARCH capability,
56 which is not the recommended way to run QEMU. This backend should not be
57 used and it will be removed with no replacement.
59 @subsection -no-frame (since 2.12.0)
61 The @code{--no-frame} argument works with SDL 1.2 only. The other user
62 interfaces never implemented this in the first place. So this will be
63 removed together with SDL 1.2 support.
65 @subsection -virtioconsole (since 3.0.0)
67 Option @option{-virtioconsole} has been replaced by
68 @option{-device virtconsole}.
70 @subsection -clock (since 3.0.0)
72 The @code{-clock} option is ignored since QEMU version 1.7.0. There is no
73 replacement since it is not needed anymore.
75 @subsection -enable-hax (since 3.0.0)
77 The @option{-enable-hax} option has been replaced by @option{-accel hax}.
78 Both options have been introduced in QEMU version 2.9.0.
80 @subsection -drive file=json:@{...@{'driver':'file'@}@} (since 3.0)
82 The 'file' driver for drives is no longer appropriate for character or host
83 devices and will only accept regular files (S_IFREG). The correct driver
84 for these file types is 'host_cdrom' or 'host_device' as appropriate.
86 @subsection -net ...,name=@var{name} (since 3.1)
88 The @option{name} parameter of the @option{-net} option is a synonym
89 for the @option{id} parameter, which should now be used instead.
91 @section QEMU Machine Protocol (QMP) commands
93 @subsection block-dirty-bitmap-add "autoload" parameter (since 2.12.0)
95 "autoload" parameter is now ignored. All bitmaps are automatically loaded
96 from qcow2 images.
98 @subsection query-cpus (since 2.12.0)
100 The ``query-cpus'' command is replaced by the ``query-cpus-fast'' command.
102 @subsection query-cpus-fast "arch" output member (since 3.0.0)
104 The ``arch'' output member of the ``query-cpus-fast'' command is
105 replaced by the ``target'' output member.
107 @section System emulator human monitor commands
109 @subsection The hub_id parameter of 'hostfwd_add' / 'hostfwd_remove' (since 3.1)
111 The @option{[hub_id name]} parameter tuple of the 'hostfwd_add' and
112 'hostfwd_remove' HMP commands has been replaced by @option{netdev_id}.
114 @section System emulator devices
116 @subsection ivshmem (since 2.6.0)
118 The ``ivshmem'' device type is replaced by either the ``ivshmem-plain''
119 or ``ivshmem-doorbell`` device types.
121 @section System emulator machines
123 @subsection pc-0.10 and pc-0.11 (since 3.0)
125 These machine types are very old and likely can not be used for live migration
126 from old QEMU versions anymore. A newer machine type should be used instead.
128 @subsection prep (PowerPC) (since 3.1)
130 This machine type uses an unmaintained firmware, broken in lots of ways,
131 and unable to start post-2004 operating systems. 40p machine type should be
132 used instead.
134 @section Device options
136 @subsection Block device options
138 @subsubsection "backing": "" (since 2.12.0)
140 In order to prevent QEMU from automatically opening an image's backing
141 chain, use ``"backing": null'' instead.
143 @subsubsection rbd keyvalue pair encoded filenames: "" (since 3.1.0)
145 Options for ``rbd'' should be specified according to its runtime options,
146 like other block drivers.  Legacy parsing of keyvalue pair encoded
147 filenames is useful to open images with the old format for backing files;
148 These image files should be updated to use the current format.
150 Example of legacy encoding:
152 @code{json:@{"file.driver":"rbd", "file.filename":"rbd:rbd/name"@}}
154 The above, converted to the current supported format:
156 @code{json:@{"file.driver":"rbd", "file.pool":"rbd", "file.image":"name"@}}
158 @subsection vio-spapr-device device options
160 @subsubsection "irq": "" (since 3.0.0)
162 The ``irq'' property is obsoleted.