Go to file
Peter Maydell f4c4357fbf docs:
* Convert qemu-doc from Texinfo to rST
 -----BEGIN PGP SIGNATURE-----
 
 iQJNBAABCAA3FiEE4aXFk81BneKOgxXPPCUl7RQ2DN4FAl5iLx8ZHHBldGVyLm1h
 eWRlbGxAbGluYXJvLm9yZwAKCRA8JSXtFDYM3nPLD/91Z1uCXz64MGGfgdje5+Ur
 4BFG1qPjL2Q9vcECK9LuF1gHnlBBDE8GCB6XyBBSIdGHJWHr3+a8ztbbuH6zesXx
 kUmGzLB1hXN/IZRHCWp41e+nUiymlJMzht5P42tzFHeakjWdb9kOfqouvZJRpyug
 jJahjAuXgbLeToLWj/2Klf//o/stzzf7g3mn1QbO5KnCsDLiJqCxjI+jFfc2sgsP
 GOZiMM4ReusnJgPPvElAg+VQiw4JWA/joNPh+KGNj9aASv+fWzmswcNzoyG8sVzU
 k5Wi2FTMwLINlWIGlWM6CfTelDuEito98mc1BEMdu5IGjrd+gi6UMW9k/c0tAetJ
 3LHXmF7+1zWsQOeKmBcQZrmG+767ebNlKt3w5brk5EbXdnknuG1PHekopHB9I2nD
 OkJEvJ60PyMbbGxQ6M4xsA4bI51aWc5rQb+l5mSp1HWhRL4MMxO5QB7t3wCPZ2ln
 BSvX0nln2O9K1AzCaI0twU7mByaWrFeo77qlwkLqA72r04LDKnpUXlMb+nNm6+yf
 YrtkCbu70AaeAJLsDZMXNLNriraO4SoFyYtUuHux0DBi/ckmiaH3hXJMQZxsjdqq
 /Qt7kqxaxt3ZStONSANbjxO4bwbb3027uSAOTa1fvh96Pcht0ak0+cDADWNS8GOZ
 e09u3rwyhaEzR68gFQXuqw==
 =GGb7
 -----END PGP SIGNATURE-----

Merge remote-tracking branch 'remotes/pmaydell/tags/pull-docs-20200306' into staging

docs:
 * Convert qemu-doc from Texinfo to rST

# gpg: Signature made Fri 06 Mar 2020 11:08:15 GMT
# gpg:                using RSA key E1A5C593CD419DE28E8315CF3C2525ED14360CDE
# gpg:                issuer "peter.maydell@linaro.org"
# gpg: Good signature from "Peter Maydell <peter.maydell@linaro.org>" [ultimate]
# gpg:                 aka "Peter Maydell <pmaydell@gmail.com>" [ultimate]
# gpg:                 aka "Peter Maydell <pmaydell@chiark.greenend.org.uk>" [ultimate]
# Primary key fingerprint: E1A5 C593 CD41 9DE2 8E83  15CF 3C25 25ED 1436 0CDE

* remotes/pmaydell/tags/pull-docs-20200306: (33 commits)
  *.hx: Remove all the STEXI/ETEXI blocks
  docs: Remove old texinfo sources
  docs: Stop building qemu-doc
  ui/cocoa.m: Update documentation file and pathname
  docs: Generate qemu.1 manpage with Sphinx
  docs: Split out sections for the manpage into .rst.inc files
  qemu-options.hx: Fix up the autogenerated rST
  qemu-options.hx: Add rST documentation fragments
  scripts/hxtool-conv: Archive script used in qemu-options.hx conversion
  docs: Roll -prom-env and -g target-specific info into qemu-options.hx
  docs: Roll semihosting option information into qemu-options.hx
  doc/scripts/hxtool.py: Strip trailing ':' from DEFHEADING/ARCHHEADING
  hmp-commands-info.hx: Add rST documentation fragments
  hmp-commands.hx: Add rST documentation fragments
  docs/system: convert Texinfo documentation to rST
  docs/system: convert the documentation of deprecated features to rST.
  docs/system: convert managed startup to rST.
  docs/system: Convert security.texi to rST format
  docs/system: Convert qemu-cpu-models.texi to rST
  docs: Create defs.rst.inc as a place to define substitutions
  ...

Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
2020-03-06 11:11:54 +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 accel/tcg: increase default code gen buffer size for 64 bit 2020-02-28 17:43:31 -08:00
audio audio/alsaaudio: Remove superfluous semicolons 2020-02-18 20:20:49 +01:00
authz authz: fix usage of bool in listfile.c 2020-02-07 12:22:19 +00:00
backends hostmem: fix strict bind policy 2020-02-19 16:50:02 +00:00
block block/replication.c: Ignore requests after failover 2020-03-03 18:04:47 +08:00
bsd-user build: move TARGET_GPROF to config-host.mak 2020-02-12 16:29:27 +01:00
capstone@22ead3e0bf
chardev qemu/queue.h: add QLIST_SAFE_REMOVE() 2020-02-22 08:26:47 +00:00
contrib libvhost-user: implement in-band notifications 2020-02-27 03:46:10 -05:00
crypto * More uses of RCU_READ_LOCK_GUARD (Dave, myself) 2019-12-20 11:20:25 +00:00
default-configs tpm: Separate TPM_TIS and TPM_TIS_ISA configs 2020-03-05 12:18:00 -05:00
disas target/mips: Add implementation of GINVT instruction 2020-01-29 19:28:52 +01:00
docs docs: Remove old texinfo sources 2020-03-06 11:06:55 +00:00
dtc@88f18909db
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: Convert documentation to rST 2020-02-03 11:02:23 +00:00
gdb-xml target/riscv: Expose "priv" register for GDB for reads 2019-10-28 07:47:29 -07:00
hw Merge tpm 2020/03/04 v2 2020-03-05 19:39:47 +00:00
include Merge tpm 2020/03/04 v2 2020-03-05 19:39:47 +00:00
io io/channel-websock: treat 'binary' and no sub-protocol as the same 2020-02-07 12:22:18 +00:00
libdecnumber
linux-headers linux-headers: update 2020-02-26 18:57:07 +01:00
linux-user target/arm: Implement v8.4-RCPC 2020-02-28 16:14:57 +00:00
migration savevm: Don't call colo_init_ram_cache twice 2020-02-28 10:13:54 +01:00
monitor multifd: Add multifd-zstd-level parameter 2020-02-28 09:25:28 +01:00
nbd nbd: Fix regression with multiple meta contexts 2020-02-26 14:45:02 -06:00
net net/filter.c: Add Options to insert filters anywhere in the filter list 2020-03-03 18:04:47 +08: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/core: add missing break in cb_to_tcg_flags 2020-02-25 20:20:23 +00:00
po ui/gtk: fix gettext message's charset. 2019-11-21 09:42:30 +01:00
python/qemu python/qemu/machine: Allow to use other serial consoles than default 2020-02-07 15:12:48 +01:00
qapi multifd: Add zstd compression multifd support 2020-02-28 09:25:49 +01:00
qga qga/qapi-schema.json: minor format fixups for rST 2020-02-15 11:41:49 +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/hxtool-conv: Archive script used in qemu-options.hx conversion 2020-03-06 10:05:24 +00:00
scsi build: rename CONFIG_LIBCAP to CONFIG_LIBCAP_NG 2019-12-17 19:35:47 +01:00
slirp@126c04acba
softmmu vl: Abort if multiple machines are registered as default 2020-02-28 14:57:19 -05:00
stubs stubs: add stubs for io_uring interface 2020-01-30 20:59:41 +00:00
target RISC-V: Add a missing "," in riscv_excp_names 2020-03-05 12:01:43 -08:00
tcg tcg/arm: Expand epilogue inline 2020-02-28 10:58:41 -08:00
tests Merge tpm 2020/03/04 v2 2020-03-05 19:39:47 +00:00
tools/virtiofsd virtiofsd: Fix xattr operations 2020-03-03 15:13:24 +00:00
trace tracing: only allow -trace to override -D if set 2020-02-25 20:20:23 +00:00
ui ui/cocoa.m: Update documentation file and pathname 2020-03-06 11:06:55 +00:00
util mem-prealloc: optimize large guest startup 2020-02-25 09:18:01 +01:00
.cirrus.yml ci: build out-of-tree 2019-12-18 20:17:55 +00:00
.dir-locals.el
.editorconfig
.exrc
.gdbinit
.gitignore docs: Stop building qemu-doc 2020-03-06 11:06:55 +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 configure: Enable test and libs for zstd 2020-02-28 09:24:43 +01:00
.gitmodules hw/ppc/prep: Remove the deprecated "prep" machine and the OpenHackware BIOS 2020-02-02 14:07:57 +11:00
.gitpublish
.mailmap mailmap: Add entry for Yu-Chen Lin 2020-02-18 20:20:49 +01:00
.patchew.yml
.readthedocs.yml .readthedocs.yml: specify some minimum python requirements 2020-02-07 15:15:16 +01:00
.shippable.yml .shippable: --disable-docs for cross-compile tests 2020-02-04 17:13:29 +00:00
.travis.yml travis.yml: install python3 numpy and opencv libraries 2020-03-04 09:57:33 +00:00
arch_init.c hw/m68k: add Nubus macfb video card 2019-10-28 19:06:49 +01:00
balloon.c
block.c qemu/queue.h: add QLIST_SAFE_REMOVE() 2020-02-22 08:26:47 +00:00
blockdev-nbd.c nbd: Allow description when creating NBD blockdev 2020-02-05 17:22:13 -06:00
blockdev.c qapi: Allow getting flat output from 'query-named-block-nodes' 2020-02-20 16:43:42 +01: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
CODING_STYLE.rst
configure configure: detect and report genisoimage 2020-03-04 09:57:33 +00:00
COPYING
COPYING.LIB
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-hotplug.c
disas.c plugin: add qemu_plugin_insn_disas helper 2019-10-28 15:12:38 +00:00
dma-helpers.c Avoid address_space_rw() with a constant is_write argument 2020-02-20 14:47:08 +01:00
exec-vary.c
exec.c Memory: Only call ramblock_ptr when needed in qemu_ram_writeback 2020-02-27 11:50:30 +00:00
gdbstub.c chardev: Use QEMUChrEvent enum in IOEventHandler typedef 2020-01-08 11:15:35 +01:00
gitdm.config
hmp-commands-info.hx *.hx: Remove all the STEXI/ETEXI blocks 2020-03-06 11:06:55 +00:00
hmp-commands.hx *.hx: Remove all the STEXI/ETEXI blocks 2020-03-06 11:06:55 +00:00
ioport.c
iothread.c
job-qmp.c
job.c
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 docs: Remove old texinfo sources 2020-03-06 11:06:55 +00:00
Makefile docs: Stop building qemu-doc 2020-03-06 11:06:55 +00:00
Makefile.objs softmmu: move vl.c to softmmu/ 2020-02-22 08:26:47 +00:00
Makefile.target fuzz: add target/fuzz makefile rules 2020-02-22 08:26:48 +00:00
memory_ldst.inc.c
memory_mapping.c
memory.c memory: batch allocate ioeventfds[] in address_space_update_ioeventfds() 2020-02-25 09:18:01 +01:00
module-common.c
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 virtio, pc: fixes, features 2020-02-27 19:15:15 +00:00
qemu-bridge-helper.c build: rename CONFIG_LIBCAP to CONFIG_LIBCAP_NG 2019-12-17 19:35:47 +01:00
qemu-edid.c
qemu-img-cmds.hx qemu-img: Add --target-is-zero to convert 2020-02-20 16:43:42 +01:00
qemu-img.c qemu-img: Fix convert -n -B for backing-less targets 2020-02-20 16:43:42 +01:00
qemu-io-cmds.c
qemu-io.c qemu-io: adds option to use aio engine 2020-01-30 20:59:42 +00:00
qemu-keymap.c
qemu-nbd.c qemu-nbd: Removed deprecated --partition option 2020-02-05 17:29:49 -06:00
qemu-options-wrapper.h
qemu-options.h
qemu-options.hx *.hx: Remove all the STEXI/ETEXI blocks 2020-03-06 11:06:55 +00:00
qemu-seccomp.c
qemu.nsi
qemu.sasl
qtest.c Merge branch 'exec_rw_const_v4' of https://github.com/philmd/qemu into HEAD 2020-02-25 13:41:48 +01:00
README.rst
replication.c
replication.h
rules.mak Makefile: Ensure we don't run Sphinx in parallel for manpages 2020-02-03 10:46:32 +00:00
thunk.c
tpm.c
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

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