QEMU main repository: Please see http://wiki.qemu.org/Contribute/SubmitAPatch for how to submit changes to QEMU. Pull Requests are ignored. Please only use release tarballs from the QEMU website. http://www.qemu.org
Go to file
John Snow 3afc32906f python: add VERSION file
Python infrastructure as it exists today is not capable reliably of
single-sourcing a package version from a parent directory. The authors
of pip are working to correct this, but as of today this is not possible.

The problem is that when using pip to build and install a python
package, it copies files over to a temporary directory and performs its
build there. This loses access to any information in the parent
directory, including git itself.

Further, Python versions have a standard (PEP 440) that may or may not
follow QEMU's versioning. In general, it does; but naturally QEMU does
not follow PEP 440. To avoid any automatically-generated conflict, a
manual version file is preferred.

I am proposing:

- Python tooling follows the QEMU version, indirectly, but with a major
  version of 0 to indicate that the API is not expected to be
  stable. This would mean version 0.5.2.0, 0.5.1.1, 0.5.3.0, etc.

- In the event that a Python package needs to be updated independently
  of the QEMU version, a pre-release alpha version should be preferred,
  but *only* after inclusion to the qemu development or stable branches.

  e.g. 0.5.2.0a1, 0.5.2.0a2, and so on should be preferred prior to
  5.2.0's release.

- The Python core tooling makes absolutely no version compatibility
  checks or constraints. It *may* work with releases of QEMU from the
  past or future, but it is not required to.

  i.e., "qemu.machine" will, for now, remain in lock-step with QEMU.

- We reserve the right to split the qemu package into independently
  versioned subpackages at a later date. This might allow for us to
  begin versioning QMP independently from QEMU at a later date, if
  we so choose.

Implement this versioning scheme by adding a VERSION file and setting it
to 0.6.0.0a1.

Signed-off-by: John Snow <jsnow@redhat.com>
Reviewed-by: Cleber Rosa <crosa@redhat.com>
Message-id: 20210527211715.394144-12-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
2021-06-01 16:21:21 -04:00
.github .github: point Repo Lockdown bot to GitLab repo 2021-02-09 20:53:56 +00:00
.gitlab-ci.d gitlab: Convert check-dco/check-patch jobs to the 'rules' syntax 2021-05-27 16:39:23 +02:00
accel Adjust types for some memory access functions. 2021-05-28 16:25:21 +01:00
audio coreaudio: Handle output device change 2021-03-16 07:17:50 +01:00
authz authz-simple: Check that 'identity' property is set 2020-11-18 10:51:35 +00:00
backends backends/tpm: Replace qemu_mutex_lock calls with QEMU_LOCK_GUARD 2021-05-13 17:43:56 +02:00
block replication: move include out of root directory 2021-05-26 14:49:46 +02:00
bsd-user pull-bsd-user-20210511 is the next round of cleanups to bsd-user in merging the 2021-05-20 15:37:44 +01:00
capstone@f8b1b83301 capstone: Update to upstream "next" branch 2020-10-03 04:23:14 -05:00
chardev ui/vdagent: add clipboard support 2021-05-21 09:42:44 +02:00
contrib vhost-user-gpu: abstract vg_cleanup_mapping_iov 2021-05-27 11:55:59 +02:00
crypto crypto: add reload for QCryptoTLSCredsClass 2021-03-23 08:48:21 +01:00
default-configs hw/mem/nvdimm: Use Kconfig 'imply' instead of 'depends on' 2021-05-26 14:49:45 +02:00
disas disas/libvixl: Protect C system header for C++ compiler 2021-05-25 16:01:43 +01:00
docs Acceptance Tests: add basic documentation on LinuxTest base class 2021-06-01 16:21:21 -04:00
dtc@85e5d83984 Makefile: dtc: update, build the libfdt target 2020-06-16 14:49:05 +01:00
dump Do not include cpu.h if it's not really necessary 2021-05-02 17:24:51 +02:00
fpu softfloat: Move round_to_int_and_pack to softfloat-parts.c.inc 2021-05-16 07:13:51 -05:00
fsdev meson: Declare have_virtfs_proxy_helper in main meson.build 2021-01-23 15:55:04 -05:00
gdb-xml target/riscv: Remove built-in GDB XML files for CSRs 2021-01-16 10:57:21 -08:00
hw usb: bugfixes for hid and xhci. 2021-05-30 20:10:30 +01:00
include virtio-gpu: add blob resource support. 2021-05-30 18:33:43 +01:00
io io: error_prepend() in qio_channel_readv_full_all() causes segfault 2021-02-12 07:50:59 -06:00
libdecnumber qemu/: fix some comment spelling errors 2020-09-17 20:35:43 +02:00
linux-headers Update linux headers to 5.11-rc2 2021-01-21 11:19:45 +01:00
linux-user linux-user/aarch64: Enable hwcap bits for sve2 and related extensions 2021-05-25 16:01:44 +01:00
meson@776acd2a80 submodules: bump meson to 0.55.3 2020-10-17 10:45:42 -04:00
migration Virtiofs, migration and hmp pull 2021-05-26 2021-05-27 14:57:01 +01:00
monitor hmp: Fix loadvm to resume the VM on success instead of failure 2021-05-26 18:39:31 +01:00
nbd nbd: server: Report holes for raw images 2021-03-08 13:08:45 -06:00
net -----BEGIN PGP SIGNATURE----- 2021-05-28 22:55:56 +01:00
pc-bios pc-bios/s390-ccw: Fix inline assembly for older versions of Clang 2021-05-14 12:38:43 +02:00
plugins accel/tcg: Reduce 'exec/tb-context.h' inclusion 2021-05-26 15:31:45 -07:00
po configure: move gettext detection to meson.build 2021-01-02 21:03:09 +01:00
python python: add VERSION file 2021-06-01 16:21:21 -04:00
qapi qtest: add a QOM object for qtest 2021-05-26 14:49:45 +02:00
qga qga: fix guest-get-disks regression 2021-04-20 16:27:45 +01:00
qobject qobject: braces {} are necessary for all arms of this statement 2021-02-04 13:20:29 +01:00
qom * Updates for the MAINTAINERS file 2021-04-01 23:34:16 +01:00
replay replay: notify CPU on event 2021-04-01 10:37:20 +02:00
roms roms/u-boot: Bump ppce500 u-boot to v2021.04 to fix broken pci support 2021-05-04 11:41:25 +10:00
scripts headers: Add udmabuf.h 2021-05-27 12:06:37 +02:00
scsi scsi: fix sense code for EREMOTEIO 2021-03-16 14:30:30 -04:00
semihosting Do not include cpu.h if it's not really necessary 2021-05-02 17:24:51 +02:00
slirp@8f43a99191 slirp: update to fix CVE-2020-29129 CVE-2020-29130 2020-11-27 20:57:11 +04:00
softmmu Adjust types for some memory access functions. 2021-05-28 16:25:21 +01:00
storage-daemon qsd: Document FUSE exports 2021-03-29 18:28:33 +02:00
stubs virtio-gpu: add blob resource support. 2021-05-30 18:33:43 +01:00
subprojects/libvhost-user build-sys: add libvhost-user missing dependencies 2021-01-23 09:26:41 -05:00
target Adjust types for some memory access functions. 2021-05-28 16:25:21 +01:00
tcg tcg/aarch64: Fix tcg_out_rotl 2021-05-26 15:33:59 -07:00
tests python: create qemu packages 2021-06-01 16:21:21 -04:00
tools tools/virtiofsd/fuse_opt.c: Replaced a malloc with GLib's g_try_malloc 2021-05-26 18:39:32 +01:00
trace trace: fix "-trace file=..." 2021-03-06 11:42:57 +01:00
ui ui/pixman: Add qemu_pixman_to_drm_format() 2021-05-27 12:07:37 +02:00
util qemu-config: load modules when instantiating option groups 2021-05-26 14:49:46 +02:00
.cirrus.yml cirrus.yml: Fix the MSYS2 task 2021-05-14 13:11:48 +02:00
.dir-locals.el
.editorconfig .editorconfig: update the automatic mode setting for Emacs 2021-03-10 15:34:11 +00:00
.exrc
.gdbinit .gdbinit: load QEMU sub-commands when gdb starts 2017-06-07 14:38:45 +01:00
.gitattributes maint: Tell git that *.py files should use python diff hunks 2021-02-15 22:13:34 -05:00
.gitignore Makefile: add GNU global tags support 2021-01-18 10:04:31 +00:00
.gitlab-ci.yml gitlab: Run Avocado tests manually (except mainstream CI) 2021-05-27 16:39:23 +02:00
.gitmodules gitmodules: use GitLab repos instead of qemu.org 2021-02-09 20:53:56 +00:00
.gitpublish Add a git-publish configuration file 2018-03-05 09:03:17 +00:00
.mailmap MAINTAINERS: chenhc@lemote.com -> chenhuacai@kernel.org 2020-12-13 16:00:58 +01:00
.patchew.yml ci: store Patchew configuration in the tree 2019-06-03 14:03:02 +02:00
.readthedocs.yml readthedocs: build with Python 3.6 2020-10-05 16:30:45 +01:00
.travis.yml travis.yml: Limit simultaneous jobs to 3 2021-02-19 06:31:40 +01:00
block.c block: Fix Transaction leak in bdrv_reopen_multiple() 2021-05-18 11:08:13 +02:00
blockdev-nbd.c qemu-nbd: Use SOMAXCONN for socket listen() backlog 2021-02-12 07:42:08 -06:00
blockdev.c block: bdrv_append(): don't consume reference 2021-04-30 12:27:47 +02:00
blockjob.c ratelimit: protect with a mutex 2021-05-04 14:15:35 +02:00
configure configure: Avoid error messages about missing *-config-*.h files 2021-05-26 14:50:05 +02:00
COPYING
COPYING.LIB COPYING.LIB: Synchronize the LGPL 2.1 with the version from gnu.org 2019-01-30 11:01:22 +01:00
cpu.c cpu: Move CPUClass::vmsd to SysemuCPUOps 2021-05-26 15:33:59 -07:00
cpus-common.c overall/alpha tcg cpus|hppa: Fix Lesser GPL version number 2020-11-15 16:43:54 +01:00
disas.c Do not include cpu.h if it's not really necessary 2021-05-02 17:24:51 +02:00
gdbstub.c gdbstub: tidy away reverse debugging check into function 2021-05-25 16:52:50 +01:00
gitdm.config contrib: gitdm: add a mapping for Janus Technologies 2019-03-12 19:31:29 +00:00
hmp-commands-info.hx migrate: remove QMP/HMP commands for speed, downtime and cache size 2021-03-18 09:22:55 +00:00
hmp-commands.hx * submodule cleanups (Philippe, myself) 2021-05-26 21:05:36 +01:00
iothread.c multi-process: define MPQemuMsg format and transmission functions 2021-02-10 09:23:28 +00:00
job-qmp.c qapi: Use QAPI_LIST_APPEND in trivial cases 2021-01-28 08:08:45 +01:00
job.c mirror: stop cancelling in-flight requests on non-force cancel in READY 2021-05-14 16:14:10 +02:00
Kconfig semihosting: Move hw/semihosting/ -> semihosting/ 2021-03-10 15:34:12 +00:00
Kconfig.host multi-process: Add config option for multi-process QEMU 2021-02-09 20:53:56 +00:00
LICENSE tcg/LICENSE: Remove out of date claim about TCG subdirectory licensing 2019-11-11 15:11:21 +01:00
MAINTAINERS accel/tcg: Keep TranslationBlock headers local to TCG 2021-05-26 15:33:59 -07:00
Makefile configure: simplify assignment to GIT_SUBMODULES 2021-05-26 14:49:45 +02:00
memory_ldst.c.inc exec/memory_ldst: Use correct type sizes 2021-05-26 08:35:51 -07:00
meson_options.txt Add NVMM accelerator: configure and build logic 2021-05-04 14:15:34 +02:00
meson.build virtio-gpu: add blob resource support. 2021-05-30 18:33:43 +01:00
module-common.c
os-posix.c remove qemu-options* from root directory 2021-05-26 14:49:46 +02:00
os-win32.c remove qemu-options* from root directory 2021-05-26 14:49:46 +02:00
page-vary-common.c exec: Build page-vary-common.c with -fno-lto 2021-03-23 19:36:47 -06:00
page-vary.c exec: Build page-vary-common.c with -fno-lto 2021-03-23 19:36:47 -06:00
qemu-bridge-helper.c qemu-bridge-helper: relocate path to default ACL 2020-09-30 19:11:36 +02:00
qemu-edid.c qemu-edid: use qemu_edid_size() 2021-05-10 11:41:02 +02:00
qemu-img-cmds.hx qemu-img: add support for rate limit in qemu-img convert 2020-10-27 15:26:20 +01:00
qemu-img.c qemu-img convert: Unshare write permission for source 2021-04-30 12:27:48 +02:00
qemu-io-cmds.c monitor: hmp_qemu_io: acquire aio contex, fix crash 2021-05-14 16:14:10 +02:00
qemu-io.c monitor: hmp_qemu_io: acquire aio contex, fix crash 2021-05-14 16:14:10 +02:00
qemu-keymap.c Include qemu-common.h exactly where needed 2019-06-12 13:20:20 +02:00
qemu-nbd.c qemu-nbd: Use user_creatable_process_cmdline() for --object 2021-03-19 10:17:14 +01:00
qemu-options.hx doc: Add notes about -mon option mode=control argument. 2021-05-26 14:49:58 +02:00
qemu.nsi nsis: adjust for new MinGW paths 2021-01-23 15:55:05 -05:00
qemu.sasl Default to GSSAPI (Kerberos) instead of DIGEST-MD5 for SASL 2017-05-09 14:41:47 +01:00
README.rst README: Add Documentation blurb 2021-03-12 15:46:30 +01:00
replication.c replication: move include out of root directory 2021-05-26 14:49:46 +02:00
thunk.c overall usermode...: Fix Lesser GPL version number 2020-11-15 16:43:40 +01:00
trace-events trace-events: Fix attribution of trace points to source 2020-09-09 17:17:58 +01:00
VERSION Open 6.1 development tree 2021-04-30 11:15:40 +01:00
version.rc configure: remove CONFIG_FILEVERSION and CONFIG_PRODUCTVERSION 2021-01-02 21:03:37 +01:00

===========
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>`_