deprecated.rst (c61a0d31f8db4cb6c54e473e9a44dca616969414) deprecated.rst (322b038c9411bae0c9f518fe1cb55934ac4e1a67)
1.. _Deprecated features:
2
3Deprecated features
4===================
5
6In general features are intended to be supported indefinitely once
7introduced into QEMU. In the event that a feature needs to be removed,
8it will be listed in this section. The feature will remain functional for the

--- 49 unchanged lines hidden (view full) ---

58Passing TCG plugins arguments through ``arg=`` is redundant is makes the
59command-line less readable, especially when the argument itself consist of a
60name and a value, e.g. ``-plugin plugin_name,arg="arg_name=arg_value"``.
61Therefore, the usage of ``arg`` is redundant. Single-word arguments are treated
62as short-form boolean values, and passed to plugins as ``arg_name=on``.
63However, short-form booleans are deprecated and full explicit ``arg_name=on``
64form is preferred.
65
1.. _Deprecated features:
2
3Deprecated features
4===================
5
6In general features are intended to be supported indefinitely once
7introduced into QEMU. In the event that a feature needs to be removed,
8it will be listed in this section. The feature will remain functional for the

--- 49 unchanged lines hidden (view full) ---

58Passing TCG plugins arguments through ``arg=`` is redundant is makes the
59command-line less readable, especially when the argument itself consist of a
60name and a value, e.g. ``-plugin plugin_name,arg="arg_name=arg_value"``.
61Therefore, the usage of ``arg`` is redundant. Single-word arguments are treated
62as short-form boolean values, and passed to plugins as ``arg_name=on``.
63However, short-form booleans are deprecated and full explicit ``arg_name=on``
64form is preferred.
65
66``-no-hpet`` (since 8.0)
67''''''''''''''''''''''''
68
69The HPET setting has been turned into a machine property.
70Use ``-machine hpet=off`` instead.
71
72``-no-acpi`` (since 8.0)
73''''''''''''''''''''''''
74
75The ``-no-acpi`` setting has been turned into a machine property.
76Use ``-machine acpi=off`` instead.
77
78``-async-teardown`` (since 8.1)
79'''''''''''''''''''''''''''''''
80
81Use ``-run-with async-teardown=on`` instead.
82
83``-chroot`` (since 8.1)
84'''''''''''''''''''''''
85
86Use ``-run-with chroot=dir`` instead.
87
88``-singlestep`` (since 8.1)
89'''''''''''''''''''''''''''
90
91The ``-singlestep`` option has been turned into an accelerator property,
92and given a name that better reflects what it actually does.
93Use ``-accel tcg,one-insn-per-tb=on`` instead.
94
95User-mode emulator command line arguments
96-----------------------------------------
97
98``-singlestep`` (since 8.1)
99'''''''''''''''''''''''''''
100
101The ``-singlestep`` option has been given a name that better reflects
102what it actually does. For both linux-user and bsd-user, use the
103new ``-one-insn-per-tb`` option instead.
104
66QEMU Machine Protocol (QMP) commands
67------------------------------------
68
69``blockdev-open-tray``, ``blockdev-close-tray`` argument ``device`` (since 2.8)
70'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
71
72Use argument ``id`` instead.
73

--- 55 unchanged lines hidden (view full) ---

129conversion happens, so that e.g. string values can be assigned to integer
130device properties or vice versa.
131
132This is a bug in QEMU that will be fixed in the future so that previously
133accepted incorrect commands will return an error. Users should make sure that
134all arguments passed to ``device_add`` are consistent with the documented
135property types.
136
105QEMU Machine Protocol (QMP) commands
106------------------------------------
107
108``blockdev-open-tray``, ``blockdev-close-tray`` argument ``device`` (since 2.8)
109'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
110
111Use argument ``id`` instead.
112

--- 55 unchanged lines hidden (view full) ---

168conversion happens, so that e.g. string values can be assigned to integer
169device properties or vice versa.
170
171This is a bug in QEMU that will be fixed in the future so that previously
172accepted incorrect commands will return an error. Users should make sure that
173all arguments passed to ``device_add`` are consistent with the documented
174property types.
175
176``StatusInfo`` member ``singlestep`` (since 8.1)
177''''''''''''''''''''''''''''''''''''''''''''''''
178
179The ``singlestep`` member of the ``StatusInfo`` returned from the
180``query-status`` command is deprecated. This member has a confusing
181name and it never did what the documentation claimed or what its name
182suggests. We do not believe that anybody is actually using the
183information provided in this member.
184
185The information it reports is whether the TCG JIT is in "one
186instruction per translated block" mode (which can be set on the
187command line or via the HMP, but not via QMP). The information remains
188available via the HMP 'info jit' command.
189
137QEMU Machine Protocol (QMP) events
138----------------------------------
139
140``MEM_UNPLUG_ERROR`` (since 6.2)
141''''''''''''''''''''''''''''''''''''''''''''''''''''''''
142
143Use the more generic event ``DEVICE_UNPLUG_GUEST_ERROR`` instead.
144
145``vcpu`` trace events (since 8.1)
146'''''''''''''''''''''''''''''''''
147
148The ability to instrument QEMU helper functions with vCPU-aware trace
149points was removed in 7.0. However QMP still exposed the vcpu
150parameter. This argument has now been deprecated and the remaining
151remaining trace points that used it are selected just by name.
152
190QEMU Machine Protocol (QMP) events
191----------------------------------
192
193``MEM_UNPLUG_ERROR`` (since 6.2)
194''''''''''''''''''''''''''''''''''''''''''''''''''''''''
195
196Use the more generic event ``DEVICE_UNPLUG_GUEST_ERROR`` instead.
197
198``vcpu`` trace events (since 8.1)
199'''''''''''''''''''''''''''''''''
200
201The ability to instrument QEMU helper functions with vCPU-aware trace
202points was removed in 7.0. However QMP still exposed the vcpu
203parameter. This argument has now been deprecated and the remaining
204remaining trace points that used it are selected just by name.
205
206Human Monitor Protocol (HMP) commands
207-------------------------------------
208
209``singlestep`` (since 8.1)
210''''''''''''''''''''''''''
211
212The ``singlestep`` command has been replaced by the ``one-insn-per-tb``
213command, which has the same behaviour but a less misleading name.
214
153Host Architectures
154------------------
155
156BE MIPS (since 7.2)
157'''''''''''''''''''
158
159As Debian 10 ("Buster") moved into LTS the big endian 32 bit version of
160MIPS moved out of support making it hard to maintain our

--- 41 unchanged lines hidden (view full) ---

202various pitfalls with regards to live migration. Use a newer machine type
203instead.
204
205Nios II ``10m50-ghrd`` and ``nios2-generic-nommu`` machines (since 8.2)
206'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
207
208The Nios II architecture is orphan.
209
215Host Architectures
216------------------
217
218BE MIPS (since 7.2)
219'''''''''''''''''''
220
221As Debian 10 ("Buster") moved into LTS the big endian 32 bit version of
222MIPS moved out of support making it hard to maintain our

--- 41 unchanged lines hidden (view full) ---

264various pitfalls with regards to live migration. Use a newer machine type
265instead.
266
267Nios II ``10m50-ghrd`` and ``nios2-generic-nommu`` machines (since 8.2)
268'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
269
270The Nios II architecture is orphan.
271
272``shix`` (since 9.0)
273''''''''''''''''''''
210
274
275The machine is no longer in existence and has been long unmaintained
276in QEMU.
277
211Backend options
212---------------
213
214Using non-persistent backing file with pmem=on (since 6.1)
215''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
216
217This option is used when ``memory-backend-file`` is consumed by emulated NVDIMM
218device. However enabling ``memory-backend-file.pmem`` option, when backing file

--- 253 unchanged lines hidden ---
278Backend options
279---------------
280
281Using non-persistent backing file with pmem=on (since 6.1)
282''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
283
284This option is used when ``memory-backend-file`` is consumed by emulated NVDIMM
285device. However enabling ``memory-backend-file.pmem`` option, when backing file

--- 253 unchanged lines hidden ---