more/qemu/README.rst

2 QEMU README
5 QEMU is a generic and open source machine & userspace emulator and
8 QEMU is capable of emulating a complete machine in software without any
10 it achieves very good performance. QEMU can also integrate with the Xen
12 hypervisor to manage the CPU. With hypervisor support, QEMU can achieve
13 near native performance for CPUs. When QEMU emulates CPUs directly it is
17 QEMU is also capable of providing userspace API virtualization for Linux
23 QEMU aims to fit into a variety of use cases. It can be invoked directly
28 open source applications such as oVirt, OpenStack and virt-manager.
30 QEMU as a whole is released under the GNU General Public License,
38 `<https://www.qemu.org/documentation/>`_. The documentation for the
40 `<https://www.qemu.org/docs/master/>`_ is generated from the ``docs/``
42 <https://www.sphinx-doc.org/en/master/>`_.
48 QEMU is multi-platform software intended to be buildable on all modern
49 Linux platforms, OS-X, Win32 (via the Mingw64 toolchain) and a variety
50 of other UNIX targets. The simple steps to build QEMU are:
53 .. code-block:: shell
60 Additional information can also be found online via the QEMU website:
62 * `<https://wiki.qemu.org/Hosts/Linux>`_
63 * `<https://wiki.qemu.org/Hosts/Mac>`_
64 * `<https://wiki.qemu.org/Hosts/W32>`_
70 The QEMU source code is maintained under the GIT version control system.
72 .. code-block:: shell
74    git clone https://gitlab.com/qemu-project/qemu.git
77 format-patch' and/or 'git send-email' to format & send the mail to the
78 qemu-devel@nongnu.org mailing list. All patches submitted must contain
79 a 'Signed-off-by' line from the author. Patches should follow the
81 <https://www.qemu.org/docs/master/devel/style.html>`_ of
85 the QEMU website:
87 * `<https://wiki.qemu.org/Contribute/SubmitAPatch>`_
88 * `<https://wiki.qemu.org/Contribute/TrivialPatches>`_
90 The QEMU website is also maintained under source control.
92 .. code-block:: shell
94   git clone https://gitlab.com/qemu-project/qemu-web.git
96 * `<https://www.qemu.org/2017/02/04/the-new-qemu-website-is-up/>`_
98 A 'git-publish' utility was created to make above process less
101 requires a working 'git send-email' setup, and by default doesn't
107 *  `<https://github.com/stefanha/git-publish>`_
109 The workflow with 'git-publish' is:
111 .. code-block:: shell
113   $ git checkout master -b my-feature
114   $ # work on new commits, add your 'Signed-off-by' lines to each
117 Your patch series will be sent and tagged as my-feature-v1 if you need to refer
122 .. code-block:: shell
124   $ git checkout my-feature # same topic branch
129 will be tagged as my-feature-v2.
134 The QEMU project uses GitLab issues to track bugs. Bugs
135 found when running code built from QEMU git or upstream released sources
138 * `<https://gitlab.com/qemu-project/qemu/-/issues>`_
140 If using QEMU via an operating system vendor pre-built binary package, it
147 * `<https://wiki.qemu.org/Contribute/ReportABug>`_
154 `<https://wiki.qemu.org/ChangeLog/>`_ or look at the git history for
161 The QEMU community can be contacted in a number of ways, with the two
164 * `<mailto:qemu-devel@nongnu.org>`_
165 * `<https://lists.nongnu.org/mailman/listinfo/qemu-devel>`_
166 * #qemu on irc.oftc.net
169 found online via the QEMU website:
171 * `<https://wiki.qemu.org/Contribute/StartHere>`_