Go to file
Peter Maydell 605ffebb2e scripts/qemu-trace-stap: Convert documentation to rST
The qemu-trace-stap documentation is currently in
scripts/qemu-trace-stap.texi in Texinfo format, which we
present to the user as:
 * a qemu-trace-stap manpage
 * but not (unusually for QEMU) part of the HTML docs

Convert the documentation to rST format that lives in
the docs/ subdirectory, and present it to the user as:
 * a qemu-trace-stap manpage
 * part of the interop/ Sphinx manual

There are minor formatting changes to suit Sphinx, but no
content changes.

Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
Tested-by: Alex Bennée <alex.bennee@linaro.org>
Message-id: 20200124162606.8787-8-peter.maydell@linaro.org
2020-02-03 11:02:23 +00:00
.gitlab-ci.d/edk2 gitlab-ci.yml: Add jobs to build EDK2 firmware binaries 2020-01-21 14:15:48 +01:00
accel * Register qdev properties as class properties (Marc-André) 2020-01-27 09:44:04 +00:00
audio audio/audio: Add missing fall through comment 2020-01-24 20:59:07 +01:00
authz Include qemu/module.h where needed, drop it from qemu-common.h 2019-06-12 13:18:33 +02:00
backends migration: Define VMSTATE_INSTANCE_ID_ANY 2020-01-20 09:10:23 +01:00
block block/io_uring: adds userspace completion polling 2020-01-30 20:59:42 +00:00
bsd-user tcg: Search includes from the project root source directory 2020-01-15 15:13:10 -10:00
capstone@22ead3e0bf disas: Add capstone as submodule 2017-10-26 11:56:20 +02:00
chardev * Compat machines fix (Denis) 2020-01-10 17:16:49 +00:00
contrib libvhost-user: Fix some memtable remap cases 2020-01-23 16:41:37 +00:00
crypto * More uses of RCU_READ_LOCK_GUARD (Dave, myself) 2019-12-20 11:20:25 +00:00
default-configs hw/misc: Add the STM32F4xx Sysconfig device 2020-01-17 14:09:29 +00:00
disas target/mips: Add implementation of GINVT instruction 2020-01-29 19:28:52 +01:00
docs scripts/qemu-trace-stap: Convert documentation to rST 2020-02-03 11:02:23 +00:00
dtc@88f18909db Update dtc/libfdt submodule to v1.4.7 2018-10-02 13:53:26 +10:00
dump hmp: drop Error pointer indirection in hmp_handle_error 2019-12-18 08:36:16 +01:00
fpu softfp: Added hardfloat conversion from float32 to float64 2019-10-30 19:03:37 +01:00
fsdev virtfs-proxy-helper.c: remove 'err_out' label in setugid() 2020-01-20 15:11:39 +01:00
gdb-xml target/riscv: Expose "priv" register for GDB for reads 2019-10-28 07:47:29 -07:00
hw ppc: spapr: Activate the FWNMI functionality 2020-02-03 11:33:11 +11:00
include migration: Include migration support for machine check handling 2020-02-03 11:33:11 +11:00
io socket: Add num connections to qio_net_listener_open_sync() 2019-09-03 23:24:42 +02:00
libdecnumber build: remove CONFIG_LIBDECNUMBER 2017-10-16 18:03:52 +02:00
linux-headers linux-headers: Update 2020-01-08 11:01:59 +11:00
linux-user linux-user: Add support for read/clear RTC voltage low detector using ioctls 2020-01-22 15:21:37 +01:00
migration migration/compress: compress QEMUFile is not writable 2020-01-29 11:28:59 +01:00
monitor qdev: move helper function to monitor/misc 2020-01-24 20:59:12 +01:00
nbd nbd: fix uninitialized variable warning 2020-01-08 16:08:17 +01:00
net chardev: Use QEMUChrEvent enum in IOEventHandler typedef 2020-01-08 11:15:35 +01:00
pc-bios hw/ppc/prep: Remove the deprecated "prep" machine and the OpenHackware BIOS 2020-02-02 14:07:57 +11:00
plugins plugins: Include trace/mem.h in api.c 2020-01-15 15:13:09 -10:00
po ui/gtk: fix gettext message's charset. 2019-11-21 09:42:30 +01:00
python/qemu python/qemu: Remove unneeded imports in __init__ 2019-12-16 18:39:51 -05:00
qapi tpm_spapr: Support TPM for ppc64 using CRQ based interface 2020-02-02 14:07:57 +11:00
qga build-sys: clean up flags included in the linker command line 2020-01-24 20:59:17 +01:00
qobject qstring: add qstring_free() 2020-01-24 20:59:13 +01:00
qom qapi/qmp: add ObjectPropertyInfo.default-value 2020-01-24 20:59:16 +01:00
replay replay: record and replay random number sources 2020-01-07 12:08:39 +01:00
roms hw/ppc/prep: Remove the deprecated "prep" machine and the OpenHackware BIOS 2020-02-02 14:07:57 +11:00
scripts scripts/qemu-trace-stap: Convert documentation to rST 2020-02-03 11:02:23 +00:00
scsi build: rename CONFIG_LIBCAP to CONFIG_LIBCAP_NG 2019-12-17 19:35:47 +01:00
slirp@126c04acba slirp: update with CVE-2019-14378 fix 2019-08-02 15:14:56 +04:00
stubs stubs: add stubs for io_uring interface 2020-01-30 20:59:41 +00:00
target target/ppc: Use probe_write for DCBZ 2020-02-03 11:33:11 +11:00
tcg tcg: Move TCG headers to include/tcg/ 2020-01-15 15:13:10 -10:00
tests tests: Silence various warnings with pseries 2020-02-03 11:33:11 +11:00
tools/virtiofsd virtiofsd: add some options to the help message 2020-01-23 16:41:37 +00:00
trace qemu_set_log_filename: filename argument may be NULL 2020-01-30 21:33:50 +00:00
ui ui/console: Display the 'none' backend in '-display help' 2020-01-21 07:29:40 +01:00
util Pull request 2020-01-31 17:37:00 +00:00
.cirrus.yml ci: build out-of-tree 2019-12-18 20:17:55 +00:00
.dir-locals.el Add .dir-locals.el file to configure emacs coding style 2015-10-08 19:46:01 +03:00
.editorconfig editorconfig: add setting for shell scripts 2019-06-12 17:53:22 +01:00
.exrc qemu: add .exrc 2012-09-07 09:02:44 +03:00
.gdbinit .gdbinit: load QEMU sub-commands when gdb starts 2017-06-07 14:38:45 +01:00
.gitignore virtiofsd: add vhost-user.json file 2020-01-23 16:41:36 +00:00
.gitlab-ci-edk2.yml gitlab-ci.yml: Add jobs to build EDK2 firmware binaries 2020-01-21 14:15:48 +01:00
.gitlab-ci.yml gitlab-ci.yml: Add jobs to build EDK2 firmware binaries 2020-01-21 14:15:48 +01:00
.gitmodules hw/ppc/prep: Remove the deprecated "prep" machine and the OpenHackware BIOS 2020-02-02 14:07:57 +11:00
.gitpublish Add a git-publish configuration file 2018-03-05 09:03:17 +00:00
.mailmap MAINTAINERS: Update mail address of Aleksandar Rikalo 2019-10-25 18:37:01 +02:00
.patchew.yml ci: store Patchew configuration in the tree 2019-06-03 14:03:02 +02:00
.shippable.yml ci: build out-of-tree 2019-12-18 20:17:55 +00:00
.travis.yml build-sys: clean up flags included in the linker command line 2020-01-24 20:59:17 +01:00
arch_init.c hw/m68k: add Nubus macfb video card 2019-10-28 19:06:49 +01:00
balloon.c Clean up inclusion of exec/cpu-common.h 2019-08-16 13:31:52 +02:00
block.c blockdev: adds bdrv_parse_aio to use io_uring 2020-01-30 20:59:41 +00:00
blockdev-nbd.c nbd: Don't send oversize strings 2019-11-18 16:01:34 -06:00
blockdev.c blockdev: adds bdrv_parse_aio to use io_uring 2020-01-30 20:59:41 +00:00
blockjob.c blockjob: Fix error message for negative speed 2019-12-18 11:21:07 +01:00
bootdevice.c bootdevice: FW_CFG interface for LCHS values 2019-10-31 11:47:38 -04:00
Changelog Use HTTPS for qemu.org and other domains 2017-11-21 13:34:13 +00:00
CODING_STYLE.rst docs: split the CODING_STYLE doc into distinct groups 2019-09-05 14:41:00 +01:00
configure configure: permit use of io_uring 2020-01-30 20:59:41 +00:00
COPYING COPYING: update from FSF 2008-10-12 17:54:42 +00:00
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 cpu: introduce cpu_in_exclusive_context() 2019-10-28 15:12:38 +00:00
cpus.c Wrapper function to wait on condition for the main loop mutex 2020-02-03 11:33:10 +11:00
device_tree.c device_tree: Fix integer overflowing in load_device_tree() 2019-04-09 16:35:40 -07:00
device-hotplug.c Include hw/hw.h exactly where needed 2019-08-16 13:31:52 +02:00
disas.c plugin: add qemu_plugin_insn_disas helper 2019-10-28 15:12:38 +00:00
dma-helpers.c dma-helpers: ensure AIO callback is invoked after cancellation 2019-08-16 19:14:04 -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 misc: use QEMU_IS_ALIGNED 2020-01-20 09:10:22 +01:00
gdbstub.c chardev: Use QEMUChrEvent enum in IOEventHandler typedef 2020-01-08 11:15:35 +01:00
gitdm.config contrib: gitdm: add a mapping for Janus Technologies 2019-03-12 19:31:29 +00:00
hmp-commands-info.hx riscv: hmp: Add a command to show virtual memory mappings 2019-09-17 08:42:43 -07:00
hmp-commands.hx hmp: Allow using qdev ID for qemu-io command 2019-12-19 18:04:25 +01:00
ioport.c Include qemu-common.h exactly where needed 2019-06-12 13:20:20 +02:00
iothread.c iothread: document about why we need explicit aio_poll() 2019-03-08 10:20:57 +00:00
job-qmp.c Include qemu-common.h exactly where needed 2019-06-12 13:20:20 +02:00
job.c job: drop job_drain 2019-09-10 08:58:43 +02:00
Kconfig.host configure: simplify vhost condition with Kconfig 2019-12-17 19:32:48 +01:00
LICENSE tcg/LICENSE: Remove out of date claim about TCG subdirectory licensing 2019-11-11 15:11:21 +01:00
MAINTAINERS scripts/qemu-trace-stap: Convert documentation to rST 2020-02-03 11:02:23 +00:00
Makefile scripts/qemu-trace-stap: Convert documentation to rST 2020-02-03 11:02:23 +00:00
Makefile.objs Makefile: Keep trace-events-subdirs ordered 2020-01-30 21:33:50 +00:00
Makefile.target crypto: move common bits for all emulators to libqemuutil 2019-12-17 19:32:48 +01:00
memory_ldst.inc.c memory: Single byte swap along the I/O path 2019-09-03 08:30:39 -07:00
memory_mapping.c Include qemu-common.h exactly where needed 2019-06-12 13:20:20 +02:00
memory.c memory.c: Use trace_event_get_state_backends() 2020-01-30 21:33:50 +00:00
module-common.c all: Clean up includes 2016-02-04 17:41:30 +00:00
os-posix.c os-posix: simplify os_find_datadir 2019-12-17 19:32:47 +01:00
os-win32.c glib: use portable g_setenv() 2019-12-17 09:05:23 +01:00
qdev-monitor.c qdev: use object_property_help() 2020-01-24 20:59:17 +01:00
qemu-bridge-helper.c build: rename CONFIG_LIBCAP to CONFIG_LIBCAP_NG 2019-12-17 19:35:47 +01:00
qemu-deprecated.texi hw/ppc/prep: Remove the deprecated "prep" machine and the OpenHackware BIOS 2020-02-02 14:07:57 +11:00
qemu-doc.texi qemu-img: Convert invocation documentation to rST 2020-02-03 11:02:22 +00:00
qemu-edid.c Include qemu-common.h exactly where needed 2019-06-12 13:20:20 +02:00
qemu-img-cmds.hx qemu-img-cmds.hx: Remove texinfo document fragments 2020-02-03 11:02:23 +00:00
qemu-img.c qemu-img: adds option to use aio engine for benchmarking 2020-01-30 20:59:42 +00:00
qemu-io-cmds.c block: Pass truncate exact=true where reasonable 2019-10-28 12:08:45 +01:00
qemu-io.c qemu-io: adds option to use aio engine 2020-01-30 20:59:42 +00:00
qemu-keymap.c Include qemu-common.h exactly where needed 2019-06-12 13:20:20 +02:00
qemu-nbd.c qemu-nbd: adds option for aio engines 2020-01-30 21:01:38 +00:00
qemu-option-trace.texi qemu-nbd: Convert invocation documentation to rST 2020-01-23 15:22:39 +00: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-block-drivers: Convert to rST 2020-01-23 15:34:04 +00:00
qemu-seccomp.c seccomp: report more useful errors from seccomp 2019-03-27 13:11:38 +01:00
qemu-tech.texi qemu-tech: Fix dangling @menu entries 2019-07-15 21:10:29 +02:00
qemu.nsi win32: fix README file in NSIS installer 2019-09-16 12:32:21 +02:00
qemu.sasl Default to GSSAPI (Kerberos) instead of DIGEST-MD5 for SASL 2017-05-09 14:41:47 +01:00
qtest.c chardev: Use QEMUChrEvent enum in IOEventHandler typedef 2020-01-08 11:15:35 +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
rules.mak Makefile: Ensure we don't run Sphinx in parallel for manpages 2020-02-03 10:46:32 +00:00
thunk.c thunk: improve readability of allocation loop 2019-03-11 18:48:20 +01:00
tpm.c tpm: Clean up error reporting in tpm_init_tpmdev() 2018-10-19 14:51:34 +02:00
trace-events trace: add mmu_index to mem_info 2019-10-28 15:12:38 +00:00
VERSION Open 5.0 development tree 2019-12-13 11:59:06 +00:00
version.rc Use HTTPS for qemu.org and other domains 2017-11-21 13:34:13 +00:00
vl.c qemu_set_log_filename: filename argument may be NULL 2020-01-30 21:33:50 +00: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>`_