Go to file
xuetest 82bdd00ec4 first commit 2021-05-10 20:01:02 +08:00
.github first commit 2021-05-10 20:01:02 +08:00
.gitlab-ci.d first commit 2021-05-10 20:01:02 +08:00
accel first commit 2021-05-10 20:01:02 +08:00
audio first commit 2021-05-10 20:01:02 +08:00
authz first commit 2021-05-10 20:01:02 +08:00
backends first commit 2021-05-10 20:01:02 +08:00
block first commit 2021-05-10 20:01:02 +08:00
bsd-user first commit 2021-05-10 20:01:02 +08:00
capstone first commit 2021-05-10 20:01:02 +08:00
chardev first commit 2021-05-10 20:01:02 +08:00
contrib first commit 2021-05-10 20:01:02 +08:00
crypto first commit 2021-05-10 20:01:02 +08:00
default-configs first commit 2021-05-10 20:01:02 +08:00
disas first commit 2021-05-10 20:01:02 +08:00
docs first commit 2021-05-10 20:01:02 +08:00
dtc first commit 2021-05-10 20:01:02 +08:00
dump first commit 2021-05-10 20:01:02 +08:00
fpu first commit 2021-05-10 20:01:02 +08:00
fsdev first commit 2021-05-10 20:01:02 +08:00
gdb-xml first commit 2021-05-10 20:01:02 +08:00
hw first commit 2021-05-10 20:01:02 +08:00
include first commit 2021-05-10 20:01:02 +08:00
io first commit 2021-05-10 20:01:02 +08:00
libdecnumber first commit 2021-05-10 20:01:02 +08:00
linux-headers first commit 2021-05-10 20:01:02 +08:00
linux-user first commit 2021-05-10 20:01:02 +08:00
meson first commit 2021-05-10 20:01:02 +08:00
migration first commit 2021-05-10 20:01:02 +08:00
monitor first commit 2021-05-10 20:01:02 +08:00
nbd first commit 2021-05-10 20:01:02 +08:00
net first commit 2021-05-10 20:01:02 +08:00
pc-bios first commit 2021-05-10 20:01:02 +08:00
plugins first commit 2021-05-10 20:01:02 +08:00
po first commit 2021-05-10 20:01:02 +08:00
python first commit 2021-05-10 20:01:02 +08:00
qapi first commit 2021-05-10 20:01:02 +08:00
qga first commit 2021-05-10 20:01:02 +08:00
qobject first commit 2021-05-10 20:01:02 +08:00
qom first commit 2021-05-10 20:01:02 +08:00
replay first commit 2021-05-10 20:01:02 +08:00
roms first commit 2021-05-10 20:01:02 +08:00
scripts first commit 2021-05-10 20:01:02 +08:00
scsi first commit 2021-05-10 20:01:02 +08:00
semihosting first commit 2021-05-10 20:01:02 +08:00
slirp first commit 2021-05-10 20:01:02 +08:00
softmmu first commit 2021-05-10 20:01:02 +08:00
storage-daemon first commit 2021-05-10 20:01:02 +08:00
stubs first commit 2021-05-10 20:01:02 +08:00
subprojects/libvhost-user first commit 2021-05-10 20:01:02 +08:00
target first commit 2021-05-10 20:01:02 +08:00
tcg first commit 2021-05-10 20:01:02 +08:00
tests first commit 2021-05-10 20:01:02 +08:00
tools first commit 2021-05-10 20:01:02 +08:00
trace first commit 2021-05-10 20:01:02 +08:00
ui first commit 2021-05-10 20:01:02 +08:00
util first commit 2021-05-10 20:01:02 +08:00
.cirrus.yml first commit 2021-05-10 20:01:02 +08:00
.dir-locals.el first commit 2021-05-10 20:01:02 +08:00
.editorconfig first commit 2021-05-10 20:01:02 +08:00
.exrc first commit 2021-05-10 20:01:02 +08:00
.gdbinit first commit 2021-05-10 20:01:02 +08:00
.gitattributes first commit 2021-05-10 20:01:02 +08:00
.gitignore first commit 2021-05-10 20:01:02 +08:00
.gitlab-ci.yml first commit 2021-05-10 20:01:02 +08:00
.gitmodules first commit 2021-05-10 20:01:02 +08:00
.gitpublish first commit 2021-05-10 20:01:02 +08:00
.mailmap first commit 2021-05-10 20:01:02 +08:00
.patchew.yml first commit 2021-05-10 20:01:02 +08:00
.readthedocs.yml first commit 2021-05-10 20:01:02 +08:00
.travis.yml first commit 2021-05-10 20:01:02 +08:00
COPYING first commit 2021-05-10 20:01:02 +08:00
COPYING.LIB first commit 2021-05-10 20:01:02 +08:00
Kconfig first commit 2021-05-10 20:01:02 +08:00
Kconfig.host first commit 2021-05-10 20:01:02 +08:00
LICENSE first commit 2021-05-10 20:01:02 +08:00
MAINTAINERS first commit 2021-05-10 20:01:02 +08:00
Makefile first commit 2021-05-10 20:01:02 +08:00
README.rst first commit 2021-05-10 20:01:02 +08:00
VERSION first commit 2021-05-10 20:01:02 +08:00
block.c first commit 2021-05-10 20:01:02 +08:00
blockdev-nbd.c first commit 2021-05-10 20:01:02 +08:00
blockdev.c first commit 2021-05-10 20:01:02 +08:00
blockjob.c first commit 2021-05-10 20:01:02 +08:00
configure first commit 2021-05-10 20:01:02 +08:00
cpu.c first commit 2021-05-10 20:01:02 +08:00
cpus-common.c first commit 2021-05-10 20:01:02 +08:00
disas.c first commit 2021-05-10 20:01:02 +08:00
gdbstub.c first commit 2021-05-10 20:01:02 +08:00
gitdm.config first commit 2021-05-10 20:01:02 +08:00
hmp-commands-info.hx first commit 2021-05-10 20:01:02 +08:00
hmp-commands.hx first commit 2021-05-10 20:01:02 +08:00
iothread.c first commit 2021-05-10 20:01:02 +08:00
job-qmp.c first commit 2021-05-10 20:01:02 +08:00
job.c first commit 2021-05-10 20:01:02 +08:00
memory_ldst.c.inc first commit 2021-05-10 20:01:02 +08:00
meson.build first commit 2021-05-10 20:01:02 +08:00
meson_options.txt first commit 2021-05-10 20:01:02 +08:00
module-common.c first commit 2021-05-10 20:01:02 +08:00
os-posix.c first commit 2021-05-10 20:01:02 +08:00
os-win32.c first commit 2021-05-10 20:01:02 +08:00
page-vary-common.c first commit 2021-05-10 20:01:02 +08:00
page-vary.c first commit 2021-05-10 20:01:02 +08:00
qemu-bridge-helper.c first commit 2021-05-10 20:01:02 +08:00
qemu-edid.c first commit 2021-05-10 20:01:02 +08:00
qemu-img-cmds.hx first commit 2021-05-10 20:01:02 +08:00
qemu-img.c first commit 2021-05-10 20:01:02 +08:00
qemu-io-cmds.c first commit 2021-05-10 20:01:02 +08:00
qemu-io.c first commit 2021-05-10 20:01:02 +08:00
qemu-keymap.c first commit 2021-05-10 20:01:02 +08:00
qemu-nbd.c first commit 2021-05-10 20:01:02 +08:00
qemu-options-wrapper.h first commit 2021-05-10 20:01:02 +08:00
qemu-options.h first commit 2021-05-10 20:01:02 +08:00
qemu-options.hx first commit 2021-05-10 20:01:02 +08:00
qemu.nsi first commit 2021-05-10 20:01:02 +08:00
qemu.sasl first commit 2021-05-10 20:01:02 +08:00
replication.c first commit 2021-05-10 20:01:02 +08:00
replication.h first commit 2021-05-10 20:01:02 +08:00
thunk.c first commit 2021-05-10 20:01:02 +08:00
trace-events first commit 2021-05-10 20:01:02 +08:00
version.rc first commit 2021-05-10 20:01:02 +08:00

README.rst

===========
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://qemu.org/Hosts/Linux>`_
* `<https://qemu.org/Hosts/Mac>`_
* `<https://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://qemu.org/Contribute/SubmitAPatch>`_
* `<https://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 Launchpad as its primary upstream bug tracker. Bugs
found when running code built from QEMU git or upstream released sources
should be reported via:

* `<https://bugs.launchpad.net/qemu/>`_

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 launchpad.

For additional information on bug reporting consult:

* `<https://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://qemu.org/Contribute/StartHere>`_