Go to file
Alex Bennée 024e8945fa readthodocs: fully specify a build environment
This is now expected by rtd so I've expanded using their example as
22.04 is one of our supported platforms. I tried to work out if there
was an easy way to re-generate a requirements.txt from our
pythondeps.toml but in the end went for the easier solution.

Cc:  <qemu-stable@nongnu.org>
Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
Message-Id: <20231221174200.2693694-1-alex.bennee@linaro.org>
(cherry picked from commit b16a45bc5e)
Signed-off-by: Michael Tokarev <mjt@tls.msk.ru>
2024-01-23 18:48:46 +03:00
.github/workflows
.gitlab/issue_templates
.gitlab-ci.d .gitlab-ci.d/buildtest.yml: Work around htags bug when environment is large 2024-01-13 11:30:27 +03:00
accel accel/tcg: mttcg remove false-negative halted assertion 2023-09-27 21:39:52 +03:00
audio
authz
backends tpm: fix crash when FD >= 1024 and unnecessary errors due to EINTR 2023-09-13 23:13:45 +03:00
block block: Fix crash when loading snapshot on inactive node 2023-12-22 22:25:35 +03:00
bsd-user
chardev chardev/char.c: fix "abstract device type" error message 2024-01-08 19:25:14 +03:00
common-user
configs
contrib
crypto
disas disas/riscv: Fix the typo of inverted order of pmpaddr13 and pmpaddr14 2023-10-21 14:05:14 +03:00
docs readthodocs: fully specify a build environment 2024-01-23 18:48:46 +03:00
dtc@b6910bec11
dump dump: kdump-zlib data pages not dumped with pvtime/aarch64 2023-09-11 10:53:50 +03:00
ebpf
fpu softfloat: Fix the incorrect computation in float32_exp2 2023-05-18 21:09:59 +03:00
fsdev 9pfs: prevent opening special files (CVE-2023-2861) 2023-06-08 23:52:29 +03:00
gdb-xml
gdbstub
hw hw/scsi/esp-pci: set DMA_STAT_BCMBLT when BLAST command issued 2024-01-20 18:31:36 +03:00
include load_elf: fix iterator's type for elf file processing 2024-01-19 13:41:14 +03:00
io io: remove io watch if TLS channel is closed during handshake 2023-08-02 17:22:20 +03:00
libdecnumber libdecnumber/dpd/decimal64: Fix compiler warning from Clang 15 2022-11-11 09:13:52 +01:00
linux-headers
linux-user linux-user: Fix loaddr computation for some elf files 2023-11-29 16:20:11 +03:00
meson@3a9b285a55
migration migration/qmp: Fix crash on setting tls-authz with null 2023-10-21 14:05:14 +03:00
monitor
nbd
net net: Update MemReentrancyGuard for NIC 2023-11-29 16:20:11 +03:00
pc-bios optionrom: Remove build-id section 2023-10-03 18:21:41 +03:00
plugins
po
python python: drop pipenv 2023-09-11 10:53:50 +03:00
qapi Block layer patches 2022-11-14 16:59:10 -05:00
qga qga/win32: Use rundll for VSS installation 2023-08-02 16:07:32 +03:00
qobject
qom
replay replay: Fix declaration of replay_read_next_clock 2022-11-29 11:09:11 -05:00
roms target/hppa: Update to SeaBIOS-hppa version 8 2023-06-26 19:35:39 +03:00
scripts tracetool: avoid invalid escape in Python string 2023-11-19 21:15:23 +03:00
scsi
semihosting
softmmu vl: Improve error message for conflicting -incoming and -loadvm 2023-12-22 22:25:35 +03:00
storage-daemon
stubs qga: Allow building of the guest agent without system emulators or tools 2022-11-11 09:17:45 +01:00
subprojects libvhost-user: check for NULL when allocating a virtqueue element 2023-03-29 10:20:04 +03:00
target target/i386: pcrel: store low bits of physical address in data[0] 2024-01-20 17:41:47 +03:00
tcg tcg: Move TCG_TARGET_HAS_direct_jump init to tb_gen_code 2022-11-09 12:29:03 +11:00
tests iotests: Basic tests for internal snapshots 2023-12-22 22:25:35 +03:00
tools virtiofsd: Add sigreturn to the seccomp whitelist 2022-11-25 13:56:05 -05:00
trace
ui ui/vnc-clipboard: fix inflate_buffer 2023-12-20 19:11:10 +03:00
util async: avoid use-after-free on re-entrancy guard 2023-09-11 10:53:50 +03:00
.cirrus.yml
.dir-locals.el
.editorconfig
.exrc
.gdbinit
.gitattributes
.gitignore
.gitlab-ci.yml
.gitmodules
.gitpublish
.mailmap
.patchew.yml
.readthedocs.yml readthodocs: fully specify a build environment 2024-01-23 18:48:46 +03:00
.travis.yml
block.c block: Make bdrv_child_get_parent_aio_context I/O 2022-11-10 14:58:34 +01:00
blockdev-nbd.c
blockdev.c block: Fix use after free in blockdev_mark_auto_del() 2023-05-18 21:09:59 +03:00
blockjob.c block: Make bdrv_child_get_parent_aio_context I/O 2022-11-10 14:58:34 +01:00
configure configure: fix GLIB_VERSION for cross-compilation 2023-03-29 10:20:04 +03:00
COPYING
COPYING.LIB
cpu.c
cpus-common.c
disas.c
event-loop-base.c
gitdm.config
hmp-commands-info.hx
hmp-commands.hx
iothread.c
job-qmp.c
job.c
Kconfig
Kconfig.host
LICENSE
MAINTAINERS MAINTAINERS: Add subprojects/libvhost-user to section "vhost" 2022-11-27 13:34:21 -05:00
Makefile
memory_ldst.c.inc
meson_options.txt gtk: disable GTK Clipboard with a new meson option 2022-11-23 12:15:06 +01:00
meson.build Revert "linux-user: fix compat with glibc >= 2.36 sys/mount.h" 2023-11-02 15:09:22 +03:00
module-common.c
os-posix.c
os-win32.c
page-vary-common.c
page-vary.c
qemu-bridge-helper.c
qemu-edid.c
qemu-img-cmds.hx
qemu-img.c qemu-img: rebase: stop when reaching EOF of old backing file 2023-11-02 15:04:24 +03:00
qemu-io-cmds.c
qemu-io.c
qemu-keymap.c
qemu-nbd.c qemu-nbd: regression with arguments passing into nbd_client_thread() 2023-07-31 09:11:17 +03:00
qemu-options.hx qemu-options.hx: Rephrase the descriptions of the -hd* and -cdrom options 2023-09-11 10:53:51 +03:00
qemu.nsi
qemu.sasl
README.rst
replication.c
trace-events
VERSION Update version for 7.2.8 release 2023-12-22 21:59:29 +03:00
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>`_