Go to file
Peter Maydell 7a470a37b0 scripts/texi2pod: Delete unused script
We no longer need the texi2pod script, so we can delete it, and
the special-casing it had in the checkpatch script.

Reviewed-by: Richard Henderson <richard.henderson@linaro.org>
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Message-Id: <20200925162316.21205-19-peter.maydell@linaro.org>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
2020-09-29 17:55:39 +02:00
.github .github: Enable repo-lockdown bot to refuse GitHub pull requests 2020-04-07 16:19:18 +01:00
.gitlab-ci.d gitlab-ci: Add cross-compiling build tests 2020-09-07 12:34:17 +02:00
accel qemu/atomic.h: rename atomic_ to qatomic_ 2020-09-23 16:07:44 +01:00
audio Pull request 2020-09-24 18:48:45 +01:00
authz qom: Remove ParentClassType argument from OBJECT_DECLARE_SIMPLE_TYPE 2020-09-18 14:12:32 -04:00
backends cryptodev-backend: Register "chardev" as class property 2020-09-22 16:46:09 -04:00
block qapi: Restrict query-uuid command to machine code 2020-09-29 15:41:35 +02:00
bsd-user meson: bsd-user 2020-08-21 06:30:38 -04:00
capstone@22ead3e0bf disas: Add capstone as submodule 2017-10-26 11:56:20 +02:00
chardev util: rename qemu_open() to qemu_open_old() 2020-09-16 10:33:48 +01:00
contrib libvhost-user: return on error in vu_log_queue_fill() 2020-09-29 03:06:12 -04:00
crypto qom: Remove ParentClassType argument from OBJECT_DECLARE_SIMPLE_TYPE 2020-09-18 14:12:32 -04:00
default-configs hw/arm: Add two NPCM7xx-based machines 2020-09-14 14:24:58 +01:00
disas disas/: fix some comment spelling errors 2020-09-17 20:40:08 +02:00
docs docs/devel/qapi-code-gen.txt: Update to new rST backend conventions 2020-09-29 17:55:39 +02:00
dtc@85e5d83984 Makefile: dtc: update, build the libfdt target 2020-06-16 14:49:05 +01:00
dump qemu/atomic.h: rename atomic_ to qatomic_ 2020-09-23 16:07:44 +01:00
fpu softfloat: Define misc operations for bfloat16 2020-08-28 10:48:07 -07:00
fsdev Pull request trivial patches 20200919 2020-09-22 15:42:23 +01:00
gdb-xml target/avr: CPU class: Add GDB support 2020-07-10 17:58:32 +02:00
hw qapi: Extract PCI commands to 'pci.json' 2020-09-29 15:41:36 +02:00
include qapi: Extract ACPI commands to 'acpi.json' 2020-09-29 15:41:36 +02:00
io qom: Remove ParentClassType argument from OBJECT_DECLARE_SIMPLE_TYPE 2020-09-18 14:12:32 -04:00
libdecnumber qemu/: fix some comment spelling errors 2020-09-17 20:35:43 +02:00
linux-headers linux headers: sync to 5.9-rc4 2020-09-29 02:14:29 -04:00
linux-user qemu/atomic.h: rename atomic_ to qatomic_ 2020-09-23 16:07:44 +01:00
meson@68ed748f84 meson: bump submodule to 0.55.1 2020-09-01 01:51:51 -04:00
migration Migration: Revert one patch for 068 fix 2020-09-29 10:29:46 +01:00
monitor qapi: Extract PCI commands to 'pci.json' 2020-09-29 15:41:36 +02:00
nbd nbd: Use CAF when looking for dirty bitmap 2020-09-07 12:31:31 +02:00
net vhost-user: save features of multiqueues if chardev is closed 2020-09-29 03:06:12 -04:00
pc-bios seabios: add bios-microvm.bin binary 2020-09-17 14:16:19 +02:00
plugins meson: link emulators without Makefile.target 2020-08-21 06:30:40 -04:00
po meson: convert po/ 2020-08-21 06:30:45 -04:00
python/qemu python/qemu: Change ConsoleSocket to optionally drain socket. 2020-07-27 09:41:56 +01:00
qapi qapi: Use rST markup for literal blocks 2020-09-29 17:55:39 +02:00
qga qga/qapi-schema.json: Add some headings 2020-09-29 17:55:39 +02:00
qobject qemu/: fix some comment spelling errors 2020-09-17 20:35:43 +02:00
qom Pull request 2020-09-24 18:48:45 +01:00
replay meson: convert replay directory to Meson 2020-08-21 06:30:23 -04:00
roms seabios: add microvm config, update build rules 2020-09-17 14:16:19 +02:00
scripts scripts/texi2pod: Delete unused script 2020-09-29 17:55:39 +02:00
scsi qemu/atomic.h: rename atomic_ to qatomic_ 2020-09-23 16:07:44 +01:00
slirp@ce94eba204 slirp: update to latest stable-4.2 branch 2020-07-28 18:27:59 +04:00
softmmu qapi: Restrict balloon-related commands to machine code 2020-09-29 15:41:35 +02:00
storage-daemon docs/interop: Convert qemu-qmp-ref to rST 2020-09-29 17:55:39 +02:00
stubs qapi: Restrict query-uuid command to machine code 2020-09-29 15:41:35 +02:00
target Pull request 2020-09-24 18:48:45 +01:00
tcg qemu/atomic.h: rename atomic_ to qatomic_ 2020-09-23 16:07:44 +01:00
tests scripts/qapi: Remove texinfo generation support 2020-09-29 17:55:39 +02:00
tools virtiofsd: Add -o allow_direct_io|no_allow_direct_io options 2020-09-25 12:45:58 +01:00
trace meson: use meson datadir instead of qemu_datadir 2020-09-01 08:51:33 -04:00
ui spice: get monitors physical dimension 2020-09-29 10:08:25 +02:00
util util/hexdump: introduce qemu_hexdump_line() 2020-09-29 02:14:30 -04:00
.cirrus.yml cirrus: Building freebsd in a single shot 2020-09-16 12:15:07 +02:00
.dir-locals.el Add .dir-locals.el file to configure emacs coding style 2015-10-08 19:46:01 +03:00
.editorconfig meson: rename included C source files to .c.inc 2020-08-21 06:18:30 -04:00
.exrc
.gdbinit .gdbinit: load QEMU sub-commands when gdb starts 2017-06-07 14:38:45 +01:00
.gitignore Add *.pyc back to the .gitignore file 2020-09-23 19:09:56 +02:00
.gitlab-ci.yml configure: add [lm32|unicore32]-softmmu to deprecation logic 2020-09-16 10:07:01 +01:00
.gitmodules gitmodules: add qemu.org vbootrom submodule 2020-09-23 13:44:59 +01:00
.gitpublish Add a git-publish configuration file 2018-03-05 09:03:17 +00:00
.mailmap mailmap: Add entry for Greg Kurz 2020-09-01 11:13:02 +02:00
.patchew.yml ci: store Patchew configuration in the tree 2019-06-03 14:03:02 +02:00
.readthedocs.yml .readthedocs.yml: specify some minimum python requirements 2020-02-07 15:15:16 +01:00
.shippable.yml configure: add [lm32|unicore32]-softmmu to deprecation logic 2020-09-16 10:07:01 +01:00
.travis.yml gitlab: create a build-deprecated target 2020-09-16 10:07:01 +01:00
block.c qemu/atomic.h: rename atomic_ to qatomic_ 2020-09-23 16:07:44 +01:00
blockdev-nbd.c blockdev-nbd: Boxed argument type for nbd-server-add 2020-03-06 17:21:28 +01:00
blockdev.c qemu/atomic.h: rename atomic_ to qatomic_ 2020-09-23 16:07:44 +01:00
blockjob.c qemu/atomic.h: rename atomic_ to qatomic_ 2020-09-23 16:07:44 +01:00
bootdevice.c error: Eliminate error_propagate() manually 2020-07-10 15:18:08 +02:00
Changelog qemu/: fix some comment spelling errors 2020-09-17 20:35:43 +02:00
CODING_STYLE.rst CODING_STYLE.rst: flesh out our naming conventions. 2020-09-10 10:34:58 +01:00
configure configure: Fix build dependencies with vhost-vdpa. 2020-09-29 02:15:24 -04: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
cpus-common.c qemu/atomic.h: rename atomic_ to qatomic_ 2020-09-23 16:07:44 +01:00
device_tree.c device_tree: Constify compat in qemu_fdt_node_path() 2020-04-30 15:35:41 +01:00
disas.c disas: Let disas::read_memory() handler return EIO on error 2020-06-10 12:10:23 -04:00
dma-helpers.c trace: switch position of headers to what Meson requires 2020-08-21 06:18:24 -04:00
exec-vary.c exec: Cache TARGET_PAGE_MASK for TARGET_PAGE_BITS_VARY 2019-10-28 10:35:20 +01:00
exec.c qemu/atomic.h: rename atomic_ to qatomic_ 2020-09-23 16:07:44 +01:00
gdbstub.c trace: switch position of headers to what Meson requires 2020-08-21 06:18:24 -04:00
gitdm.config contrib: gitdm: add a mapping for Janus Technologies 2019-03-12 19:31:29 +00:00
hmp-commands-info.hx memory: Make 'info mtree' not display disabled regions by default 2020-06-10 12:10:49 -04:00
hmp-commands.hx cphp: remove deprecated cpu-add command(s) 2020-09-29 02:14:30 -04:00
iothread.c qemu/atomic.h: rename atomic_ to qatomic_ 2020-09-23 16:07:44 +01:00
job-qmp.c trace: switch position of headers to what Meson requires 2020-08-21 06:18:24 -04:00
job.c trace: switch position of headers to what Meson requires 2020-08-21 06:18:24 -04:00
Kconfig Makefile: simplify MINIKCONF rules 2020-07-10 18:02:21 -04:00
Kconfig.host configure: Fix build dependencies with vhost-vdpa. 2020-09-29 02:15:24 -04:00
LICENSE tcg/LICENSE: Remove out of date claim about TCG subdirectory licensing 2019-11-11 15:11:21 +01:00
MAINTAINERS docs/interop: Convert qemu-ga-ref to rST 2020-09-29 17:55:39 +02:00
Makefile docs/interop: Convert qemu-qmp-ref to rST 2020-09-29 17:55:39 +02:00
memory_ldst.c.inc meson: rename included C source files to .c.inc 2020-08-21 06:18:30 -04:00
meson_options.txt meson: add description to options 2020-09-01 08:51:44 -04:00
meson.build scripts/qapi: Remove texinfo generation support 2020-09-29 17:55:39 +02:00
module-common.c all: Clean up includes 2016-02-04 17:41:30 +00:00
os-posix.c util: rename qemu_open() to qemu_open_old() 2020-09-16 10:33:48 +01:00
os-win32.c qemu/osdep: Document os_find_datadir() return value 2020-07-21 16:13:04 +02:00
qdev-monitor.c qdev: Fix device_add DRIVER,help to print to monitor 2020-07-21 17:22:44 +02:00
qemu-bridge-helper.c build: rename CONFIG_LIBCAP to CONFIG_LIBCAP_NG 2019-12-17 19:35:47 +01:00
qemu-edid.c edid: use physical dimensions if available 2020-09-29 10:08:25 +02:00
qemu-img-cmds.hx block/amend: add 'force' option 2020-07-06 08:49:28 +02:00
qemu-img.c bitmaps patches for 2020-09-21 2020-09-23 15:11:38 +01:00
qemu-io-cmds.c block: nbd: Fix convert qcow2 compressed to nbd 2020-07-28 09:54:19 -05:00
qemu-io.c block: add missing socket_init() calls to tools 2020-09-02 16:47:39 -05:00
qemu-keymap.c Include qemu-common.h exactly where needed 2019-06-12 13:20:20 +02:00
qemu-nbd.c qemu/atomic.h: rename atomic_ to qatomic_ 2020-09-23 16:07:44 +01:00
qemu-options-wrapper.h qemu-img: remove references to GEN_DOCS 2018-05-20 08:35:54 +03:00
qemu-options.h Clean up ill-advised or unusual header guards 2016-07-12 16:20:46 +02:00
qemu-options.hx qemu-options: document SMBIOS type 11 settings 2020-09-29 03:06:12 -04:00
qemu-seccomp.c seccomp: fix killing of whole process instead of thread 2020-09-15 12:56:26 +02:00
qemu.nsi qemu.nsi: Install Sphinx documentation 2020-03-09 16:45:00 +00:00
qemu.sasl Default to GSSAPI (Kerberos) instead of DIGEST-MD5 for SASL 2017-05-09 14:41:47 +01:00
README.rst docs: merge HACKING.rst contents into CODING_STYLE.rst 2019-09-05 14:27:06 +01:00
replication.c replication: Introduce new APIs to do replication operation 2016-09-13 11:00:56 +01:00
replication.h Include qemu/module.h where needed, drop it from qemu-common.h 2019-06-12 13:18:33 +02:00
thunk.c linux-user: Add strace support for printing arguments for ioctls used for terminals and serial lines 2020-08-27 12:29:50 +02:00
tpm.c tpm: Improve help on TPM types when none are available 2020-07-24 12:44:13 -04:00
trace-events trace-events: Fix attribution of trace points to source 2020-09-09 17:17:58 +01:00
VERSION Open 5.2 development tree 2020-08-18 13:44:04 +01:00
version.rc Use HTTPS for qemu.org and other domains 2017-11-21 13:34:13 +00:00
version.texi.in meson: build texi doc 2020-08-21 06:30:42 -04: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.


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://git.qemu.org/git/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 CODING_STYLE.rst file.

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://git.qemu.org/git/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>`_


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