qemu/README
<<
>>
Prefs
   1         QEMU README
   2         ===========
   3
   4QEMU is a generic and open source machine & userspace emulator and
   5virtualizer.
   6
   7QEMU is capable of emulating a complete machine in software without any
   8need for hardware virtualization support. By using dynamic translation,
   9it achieves very good performance. QEMU can also integrate with the Xen
  10and KVM hypervisors to provide emulated hardware while allowing the
  11hypervisor to manage the CPU. With hypervisor support, QEMU can achieve
  12near native performance for CPUs. When QEMU emulates CPUs directly it is
  13capable of running operating systems made for one machine (e.g. an ARMv7
  14board) on a different machine (e.g. an x86_64 PC board).
  15
  16QEMU is also capable of providing userspace API virtualization for Linux
  17and BSD kernel interfaces. This allows binaries compiled against one
  18architecture ABI (e.g. the Linux PPC64 ABI) to be run on a host using a
  19different architecture ABI (e.g. the Linux x86_64 ABI). This does not
  20involve any hardware emulation, simply CPU and syscall emulation.
  21
  22QEMU aims to fit into a variety of use cases. It can be invoked directly
  23by users wishing to have full control over its behaviour and settings.
  24It also aims to facilitate integration into higher level management
  25layers, by providing a stable command line interface and monitor API.
  26It is commonly invoked indirectly via the libvirt library when using
  27open source applications such as oVirt, OpenStack and virt-manager.
  28
  29QEMU as a whole is released under the GNU General Public License,
  30version 2. For full licensing details, consult the LICENSE file.
  31
  32
  33Building
  34========
  35
  36QEMU is multi-platform software intended to be buildable on all modern
  37Linux platforms, OS-X, Win32 (via the Mingw64 toolchain) and a variety
  38of other UNIX targets. The simple steps to build QEMU are:
  39
  40  mkdir build
  41  cd build
  42  ../configure
  43  make
  44
  45Additional information can also be found online via the QEMU website:
  46
  47  http://qemu-project.org/Hosts/Linux
  48  http://qemu-project.org/Hosts/W32
  49
  50
  51Submitting patches
  52==================
  53
  54The QEMU source code is maintained under the GIT version control system.
  55
  56   git clone git://git.qemu-project.org/qemu.git
  57
  58When submitting patches, the preferred approach is to use 'git
  59format-patch' and/or 'git send-email' to format & send the mail to the
  60qemu-devel@nongnu.org mailing list. All patches submitted must contain
  61a 'Signed-off-by' line from the author. Patches should follow the
  62guidelines set out in the HACKING and CODING_STYLE files.
  63
  64Additional information on submitting patches can be found online via
  65the QEMU website
  66
  67  http://qemu-project.org/Contribute/SubmitAPatch
  68  http://qemu-project.org/Contribute/TrivialPatches
  69
  70
  71Bug reporting
  72=============
  73
  74The QEMU project uses Launchpad as its primary upstream bug tracker. Bugs
  75found when running code built from QEMU git or upstream released sources
  76should be reported via:
  77
  78  https://bugs.launchpad.net/qemu/
  79
  80If using QEMU via an operating system vendor pre-built binary package, it
  81is preferable to report bugs to the vendor's own bug tracker first. If
  82the bug is also known to affect latest upstream code, it can also be
  83reported via launchpad.
  84
  85For additional information on bug reporting consult:
  86
  87  http://qemu-project.org/Contribute/ReportABug
  88
  89
  90Contact
  91=======
  92
  93The QEMU community can be contacted in a number of ways, with the two
  94main methods being email and IRC
  95
  96 - qemu-devel@nongnu.org
  97   http://lists.nongnu.org/mailman/listinfo/qemu-devel
  98 - #qemu on irc.oftc.net
  99
 100Information on additional methods of contacting the community can be
 101found online via the QEMU website:
 102
 103  http://qemu-project.org/Contribute/StartHere
 104
 105-- End
 106