QEMU With E2K User Support
Go to file
Peter Maydell 78813586b0 virtfs-proxy-helper: Convert documentation to rST
The virtfs-proxy-helper documentation is currently in
fsdev/qemu-trace-stap.texi in Texinfo format, which we
present to the user as:
 * a virtfs-proxy-helper 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 virtfs-proxy-helper manpage
 * part of the interop/ Sphinx manual

There are minor formatting changes to suit Sphinx, but no
content changes. In particular I've split the -u and -g
options into each having their own description text.

Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Acked-by: Greg Kurz <groug@kaod.org>
Message-id: 20200124162606.8787-9-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
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
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 virtfs-proxy-helper: Convert documentation to rST 2020-02-03 11:02:23 +00:00
dtc@88f18909db
dump hmp: drop Error pointer indirection in hmp_handle_error 2019-12-18 08:36:16 +01:00
fpu
fsdev virtfs-proxy-helper: Convert documentation to rST 2020-02-03 11:02:23 +00:00
gdb-xml
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
libdecnumber
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
python/qemu
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
slirp@126c04acba
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
.editorconfig
.exrc
.gdbinit
.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
.mailmap
.patchew.yml
.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
balloon.c
block.c blockdev: adds bdrv_parse_aio to use io_uring 2020-01-30 20:59:41 +00:00
blockdev-nbd.c
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
Changelog
CODING_STYLE.rst
configure configure: permit use of io_uring 2020-01-30 20:59:41 +00:00
COPYING
COPYING.LIB
cpus-common.c
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
dma-helpers.c
exec-vary.c
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
hmp-commands-info.hx
hmp-commands.hx hmp: Allow using qdev ID for qemu-io command 2019-12-19 18:04:25 +01:00
ioport.c
iothread.c
job-qmp.c
job.c
Kconfig.host
LICENSE
MAINTAINERS virtfs-proxy-helper: Convert documentation to rST 2020-02-03 11:02:23 +00:00
Makefile virtfs-proxy-helper: 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
memory_ldst.inc.c
memory_mapping.c
memory.c memory.c: Use trace_event_get_state_backends() 2020-01-30 21:33:50 +00:00
module-common.c
os-posix.c
os-win32.c
qdev-monitor.c qdev: use object_property_help() 2020-01-24 20:59:17 +01:00
qemu-bridge-helper.c
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
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
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: 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-options.h
qemu-options.hx qemu-block-drivers: Convert to rST 2020-01-23 15:34:04 +00:00
qemu-seccomp.c
qemu-tech.texi
qemu.nsi
qemu.sasl
qtest.c chardev: Use QEMUChrEvent enum in IOEventHandler typedef 2020-01-08 11:15:35 +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
VERSION
version.rc
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>`_