blob: 23795b83774004ade9ccb88bd0e438101a8c9fa0 [file] [log] [blame]
Daniel P. Berrangé336a7452019-08-23 17:09:24 +01001===========
2QEMU README
3===========
bellard3ef693a2003-03-23 20:17:16 +00004
Daniel P. Berrange0a3c1902015-10-12 18:41:19 +01005QEMU is a generic and open source machine & userspace emulator and
6virtualizer.
7
8QEMU is capable of emulating a complete machine in software without any
9need for hardware virtualization support. By using dynamic translation,
10it achieves very good performance. QEMU can also integrate with the Xen
11and KVM hypervisors to provide emulated hardware while allowing the
12hypervisor to manage the CPU. With hypervisor support, QEMU can achieve
13near native performance for CPUs. When QEMU emulates CPUs directly it is
14capable of running operating systems made for one machine (e.g. an ARMv7
15board) on a different machine (e.g. an x86_64 PC board).
16
17QEMU is also capable of providing userspace API virtualization for Linux
18and BSD kernel interfaces. This allows binaries compiled against one
19architecture ABI (e.g. the Linux PPC64 ABI) to be run on a host using a
20different architecture ABI (e.g. the Linux x86_64 ABI). This does not
21involve any hardware emulation, simply CPU and syscall emulation.
22
23QEMU aims to fit into a variety of use cases. It can be invoked directly
24by users wishing to have full control over its behaviour and settings.
25It also aims to facilitate integration into higher level management
26layers, by providing a stable command line interface and monitor API.
27It is commonly invoked indirectly via the libvirt library when using
28open source applications such as oVirt, OpenStack and virt-manager.
29
30QEMU as a whole is released under the GNU General Public License,
31version 2. For full licensing details, consult the LICENSE file.
32
33
John Snow33bf4722020-11-04 14:30:32 -050034Documentation
35=============
36
37Documentation can be found hosted online at
38`<https://www.qemu.org/documentation/>`_. The documentation for the
39current development version that is available at
40`<https://www.qemu.org/docs/master/>`_ is generated from the ``docs/``
41folder in the source tree, and is built by `Sphinx
42<https://www.sphinx-doc.org/en/master/>_`.
43
44
Daniel P. Berrange0a3c1902015-10-12 18:41:19 +010045Building
Pranith Kumarb95aae12016-07-20 16:31:29 -040046========
Daniel P. Berrange0a3c1902015-10-12 18:41:19 +010047
48QEMU is multi-platform software intended to be buildable on all modern
49Linux platforms, OS-X, Win32 (via the Mingw64 toolchain) and a variety
50of other UNIX targets. The simple steps to build QEMU are:
51
Daniel P. Berrangé336a7452019-08-23 17:09:24 +010052
53.. code-block:: shell
54
Pranith Kumarb95aae12016-07-20 16:31:29 -040055 mkdir build
56 cd build
57 ../configure
58 make
Daniel P. Berrange0a3c1902015-10-12 18:41:19 +010059
Daniel P. Berrange0a3c1902015-10-12 18:41:19 +010060Additional information can also be found online via the QEMU website:
61
Greg Kurz1c3515a2021-10-18 15:45:08 +020062* `<https://wiki.qemu.org/Hosts/Linux>`_
63* `<https://wiki.qemu.org/Hosts/Mac>`_
64* `<https://wiki.qemu.org/Hosts/W32>`_
Daniel P. Berrange0a3c1902015-10-12 18:41:19 +010065
66
67Submitting patches
Pranith Kumarb95aae12016-07-20 16:31:29 -040068==================
Daniel P. Berrange0a3c1902015-10-12 18:41:19 +010069
70The QEMU source code is maintained under the GIT version control system.
71
Daniel P. Berrangé336a7452019-08-23 17:09:24 +010072.. code-block:: shell
73
Stefan Hajnoczi2ad78432021-01-11 11:50:15 +000074 git clone https://gitlab.com/qemu-project/qemu.git
Daniel P. Berrange0a3c1902015-10-12 18:41:19 +010075
Fam Zheng23500c62018-02-26 11:03:26 +080076When submitting patches, one common approach is to use 'git
Daniel P. Berrange0a3c1902015-10-12 18:41:19 +010077format-patch' and/or 'git send-email' to format & send the mail to the
78qemu-devel@nongnu.org mailing list. All patches submitted must contain
79a 'Signed-off-by' line from the author. Patches should follow the
Alex Bennée93a11002021-02-23 09:59:31 +000080guidelines set out in the `style section
81<https://www.qemu.org/docs/master/devel/style.html>` of
82the Developers Guide.
Daniel P. Berrange0a3c1902015-10-12 18:41:19 +010083
84Additional information on submitting patches can be found online via
85the QEMU website
86
Greg Kurz1c3515a2021-10-18 15:45:08 +020087* `<https://wiki.qemu.org/Contribute/SubmitAPatch>`_
88* `<https://wiki.qemu.org/Contribute/TrivialPatches>`_
Daniel P. Berrange0a3c1902015-10-12 18:41:19 +010089
Eric Blakea348f642017-11-29 09:25:10 -060090The QEMU website is also maintained under source control.
91
Daniel P. Berrangé336a7452019-08-23 17:09:24 +010092.. code-block:: shell
93
Stefan Hajnoczi2ad78432021-01-11 11:50:15 +000094 git clone https://gitlab.com/qemu-project/qemu-web.git
Daniel P. Berrangé336a7452019-08-23 17:09:24 +010095
96* `<https://www.qemu.org/2017/02/04/the-new-qemu-website-is-up/>`_
Daniel P. Berrange0a3c1902015-10-12 18:41:19 +010097
Fam Zheng7c9e2742018-03-06 10:43:28 +080098A 'git-publish' utility was created to make above process less
Fam Zheng23500c62018-02-26 11:03:26 +080099cumbersome, and is highly recommended for making regular contributions,
100or even just for sending consecutive patch series revisions. It also
101requires a working 'git send-email' setup, and by default doesn't
102automate everything, so you may want to go through the above steps
103manually for once.
104
105For installation instructions, please go to
106
Daniel P. Berrangé336a7452019-08-23 17:09:24 +0100107* `<https://github.com/stefanha/git-publish>`_
Fam Zheng23500c62018-02-26 11:03:26 +0800108
109The workflow with 'git-publish' is:
110
Daniel P. Berrangé336a7452019-08-23 17:09:24 +0100111.. code-block:: shell
112
Fam Zheng23500c62018-02-26 11:03:26 +0800113 $ git checkout master -b my-feature
114 $ # work on new commits, add your 'Signed-off-by' lines to each
115 $ git publish
116
117Your patch series will be sent and tagged as my-feature-v1 if you need to refer
118back to it in the future.
119
120Sending v2:
121
Daniel P. Berrangé336a7452019-08-23 17:09:24 +0100122.. code-block:: shell
123
Fam Zheng23500c62018-02-26 11:03:26 +0800124 $ git checkout my-feature # same topic branch
125 $ # making changes to the commits (using 'git rebase', for example)
126 $ git publish
127
128Your patch series will be sent with 'v2' tag in the subject and the git tip
129will be tagged as my-feature-v2.
130
Daniel P. Berrange0a3c1902015-10-12 18:41:19 +0100131Bug reporting
Pranith Kumarb95aae12016-07-20 16:31:29 -0400132=============
Daniel P. Berrange0a3c1902015-10-12 18:41:19 +0100133
Stefan Weile2abbea2021-06-19 17:42:53 +0200134The QEMU project uses GitLab issues to track bugs. Bugs
Daniel P. Berrange0a3c1902015-10-12 18:41:19 +0100135found when running code built from QEMU git or upstream released sources
136should be reported via:
137
Stefan Weile2abbea2021-06-19 17:42:53 +0200138* `<https://gitlab.com/qemu-project/qemu/-/issues>`_
Daniel P. Berrange0a3c1902015-10-12 18:41:19 +0100139
140If using QEMU via an operating system vendor pre-built binary package, it
141is preferable to report bugs to the vendor's own bug tracker first. If
142the bug is also known to affect latest upstream code, it can also be
Stefan Weile2abbea2021-06-19 17:42:53 +0200143reported via GitLab.
Daniel P. Berrange0a3c1902015-10-12 18:41:19 +0100144
145For additional information on bug reporting consult:
146
Greg Kurz1c3515a2021-10-18 15:45:08 +0200147* `<https://wiki.qemu.org/Contribute/ReportABug>`_
Daniel P. Berrange0a3c1902015-10-12 18:41:19 +0100148
149
John Snowe83029f2020-10-26 15:51:31 -0400150ChangeLog
151=========
152
153For version history and release notes, please visit
154`<https://wiki.qemu.org/ChangeLog/>`_ or look at the git history for
155more detailed information.
156
157
Daniel P. Berrange0a3c1902015-10-12 18:41:19 +0100158Contact
Pranith Kumarb95aae12016-07-20 16:31:29 -0400159=======
Daniel P. Berrange0a3c1902015-10-12 18:41:19 +0100160
161The QEMU community can be contacted in a number of ways, with the two
162main methods being email and IRC
163
Daniel P. Berrangé336a7452019-08-23 17:09:24 +0100164* `<mailto:qemu-devel@nongnu.org>`_
165* `<https://lists.nongnu.org/mailman/listinfo/qemu-devel>`_
166* #qemu on irc.oftc.net
Daniel P. Berrange0a3c1902015-10-12 18:41:19 +0100167
168Information on additional methods of contacting the community can be
169found online via the QEMU website:
170
Greg Kurz1c3515a2021-10-18 15:45:08 +0200171* `<https://wiki.qemu.org/Contribute/StartHere>`_