QEMU main repository: Please see http://wiki.qemu.org/Contribute/SubmitAPatch for how to submit changes to QEMU. Pull Requests are ignored. Please only use release tarballs from the QEMU website. http://www.qemu.org
Go to file
Peter Maydell d56572584d docs/interop: Convert qmp-spec.txt to rST
Convert the qmp-spec.txt document to restructuredText.
Notable points about the conversion:
 * numbers at the start of section headings are removed, to match
   the style of the rest of the manual
 * cross-references to other sections or documents are hyperlinked
 * various formatting tweaks (notably the examples, which need the
   -> and <- prefixed so the QMP code-block lexer will accept them)
 * English prose fixed in a few places

Reviewed-by: Eric Blake <eblake@redhat.com>
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Message-Id: <20230515162245.3964307-2-peter.maydell@linaro.org>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
[.. code-block:: dumbed down to :: to work around CI failure]
2023-05-22 10:21:01 +02:00
.github/workflows
.gitlab/issue_templates
.gitlab-ci.d Revert last two patches 2023-05-19 12:15:03 -07:00
accel accel/tcg: Fix append_mem_cb 2023-05-18 09:28:44 -07:00
audio audio/pwaudio.c: Add Pipewire audio backend for QEMU 2023-05-05 13:23:08 +04:00
authz
backends thread-pool: avoid passing the pool parameter every time 2023-04-25 13:17:28 +02:00
block block: add accounting for zone append operation 2023-05-15 08:18:10 -04:00
bsd-user disas: Remove target_ulong from the interface 2023-05-11 09:49:51 +01:00
chardev
common-user
configs Hexagon (gdbstub): add HVX support 2023-05-18 12:40:52 -07:00
contrib build: move warning flag selection to meson 2023-05-18 13:35:28 +02:00
crypto
disas disas: Move disas.c into the target-independent source set 2023-05-11 09:51:07 +01:00
docs docs/interop: Convert qmp-spec.txt to rST 2023-05-22 10:21:01 +02:00
dtc@b6910bec11
dump
ebpf
fpu softfloat: Fix the incorrect computation in float32_exp2 2023-05-05 16:57:48 +01:00
fsdev
gdb-xml Hexagon (gdbstub): add HVX support 2023-05-18 12:40:52 -07:00
gdbstub gdbstub: only send stop-reply packets when allowed to 2023-05-18 12:40:52 -07:00
hw virtio,pc,pci: fixes, features, cleanups 2023-05-19 12:17:16 -07:00
include virtio,pc,pci: fixes, features, cleanups 2023-05-19 12:17:16 -07:00
io
libdecnumber
linux-headers Update linux headers to v6.3rc5 2023-04-28 15:55:55 +02:00
linux-user Hexagon update 2023-05-18 20:44:34 -07:00
migration Migration Pull request 2023-05-18 11:07:06 -07:00
monitor
nbd nbd: mark more coroutine_fns, do not use co_wrappers 2023-04-25 13:17:28 +02:00
net configure: add --disable-colo-proxy option 2023-05-18 18:40:50 +02:00
pc-bios
plugins
po
python docs/interop: Convert qmp-spec.txt to rST 2023-05-22 10:21:01 +02:00
qapi docs/interop: Convert qmp-spec.txt to rST 2023-05-22 10:21:01 +02:00
qga meson: use prefer_static option 2023-05-18 08:53:51 +02:00
qobject docs/interop: Convert qmp-spec.txt to rST 2023-05-22 10:21:01 +02:00
qom
replay accel/tcg/tcg-accel-ops-rr: ensure fairness with icount 2023-05-11 09:53:41 +01:00
roms
scripts qapi: Improve error message for description following section 2023-05-22 10:03:26 +02:00
scsi qemu-pr-helper: mark more coroutine_fns 2023-04-25 13:17:28 +02:00
semihosting
softmmu migration: Add last stage indicator to global dirty log 2023-05-18 08:53:50 +02:00
stats
storage-daemon qapi storage-daemon/qapi: Fix documentation section structure 2023-04-28 11:48:34 +02:00
stubs migration: process_incoming_migration_co(): move colo part to colo 2023-05-18 18:40:51 +02:00
subprojects Fix libvhost-user.c compilation. 2023-04-28 12:50:34 +02:00
target Revert "arm/kvm: add support for MTE" 2023-05-19 08:01:15 -07:00
tcg meson: remove static_kwargs 2023-05-18 08:53:51 +02:00
tests qapi: Improve error message for description following section 2023-05-22 10:03:26 +02:00
tools
trace cpu: expose qemu_cpu_list_lock for lock-guard use 2023-05-11 09:53:41 +01:00
ui ui: Fix pixel colour channel order for PNG screenshots 2023-05-12 15:43:38 +01:00
util build: move coroutine backend selection to meson 2023-05-18 08:53:52 +02:00
.dir-locals.el
.editorconfig
.exrc
.gdbinit
.git-blame-ignore-revs
.gitattributes
.gitignore
.gitlab-ci.yml
.gitmodules qemu.git: drop meson git submodule 2023-05-18 08:53:51 +02:00
.gitpublish
.mailmap
.patchew.yml
.readthedocs.yml
.travis.yml
block.c block: add zoned BlockDriver check to block layer 2023-05-15 08:17:03 -04:00
blockdev-nbd.c
blockdev.c block: Mark bdrv_recurse_can_replace() and callers GRAPH_RDLOCK 2023-05-10 14:16:54 +02:00
blockjob.c
configure Hexagon update 2023-05-18 20:44:34 -07:00
COPYING
COPYING.LIB
cpu.c cpu: Introduce a wrapper for being able to use TARGET_NAME in common code 2023-05-16 09:14:18 +02:00
cpus-common.c cpu: expose qemu_cpu_list_lock for lock-guard use 2023-05-11 09:53:41 +01:00
event-loop-base.c
gitdm.config
hmp-commands-info.hx
hmp-commands.hx build: move COLO under CONFIG_REPLICATION 2023-05-10 18:48:11 +02:00
iothread.c
job-qmp.c
job.c
Kconfig
Kconfig.host
LICENSE
MAINTAINERS Hexagon update 2023-05-18 20:44:34 -07:00
Makefile make: clean after distclean deletes source files 2023-05-18 08:53:51 +02:00
memory_ldst.c.inc
meson_options.txt Migration Pull request 2023-05-18 11:07:06 -07:00
meson.build Hexagon update 2023-05-18 20:44:34 -07:00
module-common.c
os-posix.c util/async-teardown: wire up query-command-line-options 2023-05-16 09:14:18 +02:00
os-win32.c
page-vary-common.c
page-vary.c
qemu-bridge-helper.c
qemu-edid.c
qemu-img-cmds.hx
qemu-img.c block: Mark bdrv_query_block_graph_info() and callers GRAPH_RDLOCK 2023-05-10 14:16:54 +02:00
qemu-io-cmds.c qemu-iotests: test zone append operation 2023-05-15 08:18:10 -04:00
qemu-io.c
qemu-keymap.c
qemu-nbd.c
qemu-options.hx util/async-teardown: wire up query-command-line-options 2023-05-16 09:14:18 +02:00
qemu.nsi
qemu.sasl
README.rst
replication.c
trace-events
VERSION
version.rc

===========
QEMU README
===========

QEMU is a generic and open source machine & userspace emulator and
virtualizer.

QEMU is capable of emulating a complete machine in software without any
need for hardware virtualization support. By using dynamic translation,
it achieves very good performance. QEMU can also integrate with the Xen
and KVM hypervisors to provide emulated hardware while allowing the
hypervisor to manage the CPU. With hypervisor support, QEMU can achieve
near native performance for CPUs. When QEMU emulates CPUs directly it is
capable of running operating systems made for one machine (e.g. an ARMv7
board) on a different machine (e.g. an x86_64 PC board).

QEMU is also capable of providing userspace API virtualization for Linux
and BSD kernel interfaces. This allows binaries compiled against one
architecture ABI (e.g. the Linux PPC64 ABI) to be run on a host using a
different architecture ABI (e.g. the Linux x86_64 ABI). This does not
involve any hardware emulation, simply CPU and syscall emulation.

QEMU aims to fit into a variety of use cases. It can be invoked directly
by users wishing to have full control over its behaviour and settings.
It also aims to facilitate integration into higher level management
layers, by providing a stable command line interface and monitor API.
It is commonly invoked indirectly via the libvirt library when using
open source applications such as oVirt, OpenStack and virt-manager.

QEMU as a whole is released under the GNU General Public License,
version 2. For full licensing details, consult the LICENSE file.


Documentation
=============

Documentation can be found hosted online at
`<https://www.qemu.org/documentation/>`_. The documentation for the
current development version that is available at
`<https://www.qemu.org/docs/master/>`_ is generated from the ``docs/``
folder in the source tree, and is built by `Sphinx
<https://www.sphinx-doc.org/en/master/>`_.


Building
========

QEMU is multi-platform software intended to be buildable on all modern
Linux platforms, OS-X, Win32 (via the Mingw64 toolchain) and a variety
of other UNIX targets. The simple steps to build QEMU are:


.. code-block:: shell

  mkdir build
  cd build
  ../configure
  make

Additional information can also be found online via the QEMU website:

* `<https://wiki.qemu.org/Hosts/Linux>`_
* `<https://wiki.qemu.org/Hosts/Mac>`_
* `<https://wiki.qemu.org/Hosts/W32>`_


Submitting patches
==================

The QEMU source code is maintained under the GIT version control system.

.. code-block:: shell

   git clone https://gitlab.com/qemu-project/qemu.git

When submitting patches, one common approach is to use 'git
format-patch' and/or 'git send-email' to format & send the mail to the
qemu-devel@nongnu.org mailing list. All patches submitted must contain
a 'Signed-off-by' line from the author. Patches should follow the
guidelines set out in the `style section
<https://www.qemu.org/docs/master/devel/style.html>`_ of
the Developers Guide.

Additional information on submitting patches can be found online via
the QEMU website

* `<https://wiki.qemu.org/Contribute/SubmitAPatch>`_
* `<https://wiki.qemu.org/Contribute/TrivialPatches>`_

The QEMU website is also maintained under source control.

.. code-block:: shell

  git clone https://gitlab.com/qemu-project/qemu-web.git

* `<https://www.qemu.org/2017/02/04/the-new-qemu-website-is-up/>`_

A 'git-publish' utility was created to make above process less
cumbersome, and is highly recommended for making regular contributions,
or even just for sending consecutive patch series revisions. It also
requires a working 'git send-email' setup, and by default doesn't
automate everything, so you may want to go through the above steps
manually for once.

For installation instructions, please go to

*  `<https://github.com/stefanha/git-publish>`_

The workflow with 'git-publish' is:

.. code-block:: shell

  $ git checkout master -b my-feature
  $ # work on new commits, add your 'Signed-off-by' lines to each
  $ git publish

Your patch series will be sent and tagged as my-feature-v1 if you need to refer
back to it in the future.

Sending v2:

.. code-block:: shell

  $ git checkout my-feature # same topic branch
  $ # making changes to the commits (using 'git rebase', for example)
  $ git publish

Your patch series will be sent with 'v2' tag in the subject and the git tip
will be tagged as my-feature-v2.

Bug reporting
=============

The QEMU project uses GitLab issues to track bugs. Bugs
found when running code built from QEMU git or upstream released sources
should be reported via:

* `<https://gitlab.com/qemu-project/qemu/-/issues>`_

If using QEMU via an operating system vendor pre-built binary package, it
is preferable to report bugs to the vendor's own bug tracker first. If
the bug is also known to affect latest upstream code, it can also be
reported via GitLab.

For additional information on bug reporting consult:

* `<https://wiki.qemu.org/Contribute/ReportABug>`_


ChangeLog
=========

For version history and release notes, please visit
`<https://wiki.qemu.org/ChangeLog/>`_ or look at the git history for
more detailed information.


Contact
=======

The QEMU community can be contacted in a number of ways, with the two
main methods being email and IRC

* `<mailto:qemu-devel@nongnu.org>`_
* `<https://lists.nongnu.org/mailman/listinfo/qemu-devel>`_
* #qemu on irc.oftc.net

Information on additional methods of contacting the community can be
found online via the QEMU website:

* `<https://wiki.qemu.org/Contribute/StartHere>`_