diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/_templates/footer.html | 14 | ||||
| -rw-r--r-- | docs/about/build-platforms.rst (renamed from docs/system/build-platforms.rst) | 0 | ||||
| -rw-r--r-- | docs/about/deprecated.rst (renamed from docs/system/deprecated.rst) | 0 | ||||
| -rw-r--r-- | docs/about/index.rst | 27 | ||||
| -rw-r--r-- | docs/about/license.rst (renamed from docs/system/license.rst) | 0 | ||||
| -rw-r--r-- | docs/about/removed-features.rst (renamed from docs/system/removed-features.rst) | 0 | ||||
| -rw-r--r-- | docs/conf.py | 2 | ||||
| -rw-r--r-- | docs/devel/index.rst | 7 | ||||
| -rw-r--r-- | docs/index.rst | 1 | ||||
| -rw-r--r-- | docs/interop/index.rst | 9 | ||||
| -rw-r--r-- | docs/meson.build | 3 | ||||
| -rw-r--r-- | docs/specs/index.rst | 7 | ||||
| -rw-r--r-- | docs/system/arm/cubieboard.rst | 16 | ||||
| -rw-r--r-- | docs/system/arm/emcraft-sf2.rst | 15 | ||||
| -rw-r--r-- | docs/system/arm/highbank.rst | 19 | ||||
| -rw-r--r-- | docs/system/index.rst | 11 | ||||
| -rw-r--r-- | docs/system/target-arm.rst | 3 | ||||
| -rw-r--r-- | docs/tools/index.rst | 7 | ||||
| -rw-r--r-- | docs/user/index.rst | 7 |
19 files changed, 107 insertions, 41 deletions
diff --git a/docs/_templates/footer.html b/docs/_templates/footer.html new file mode 100644 index 0000000000..977053b541 --- /dev/null +++ b/docs/_templates/footer.html @@ -0,0 +1,14 @@ +{% extends "!footer.html" %} +{% block extrafooter %} + +<!-- Empty para to force a blank line after "Built with Sphinx ..." --> +<p></p> + +<p>This documentation is for QEMU version {{ version }}.</p> + +{% trans path=pathto('about/license') %} +<p><a href="{{ path }}">QEMU and this manual are released under the +GNU General Public License, version 2.</a></p> +{% endtrans %} +{{ super() }} +{% endblock %} diff --git a/docs/system/build-platforms.rst b/docs/about/build-platforms.rst index 692323609e..692323609e 100644 --- a/docs/system/build-platforms.rst +++ b/docs/about/build-platforms.rst diff --git a/docs/system/deprecated.rst b/docs/about/deprecated.rst index 6d438f1c8d..6d438f1c8d 100644 --- a/docs/system/deprecated.rst +++ b/docs/about/deprecated.rst diff --git a/docs/about/index.rst b/docs/about/index.rst new file mode 100644 index 0000000000..689a9861dc --- /dev/null +++ b/docs/about/index.rst @@ -0,0 +1,27 @@ +About QEMU +========== + +QEMU is a generic and open source machine emulator and virtualizer. + +QEMU can be used in several different ways. The most common is for +"system emulation", where it provides a virtual model of an +entire machine (CPU, memory and emulated devices) to run a guest OS. +In this mode the CPU may be fully emulated, or it may work with +a hypervisor such as KVM, Xen, Hax or Hypervisor.Framework to +allow the guest to run directly on the host CPU. + +The second supported way to use QEMU is "user mode emulation", +where QEMU can launch processes compiled for one CPU on another CPU. +In this mode the CPU is always emulated. + +QEMU also provides a number of standalone commandline utilities, +such as the `qemu-img` disk image utility that allows you to create, +convert and modify disk images. + +.. toctree:: + :maxdepth: 2 + + build-platforms + deprecated + removed-features + license diff --git a/docs/system/license.rst b/docs/about/license.rst index cde3d2d25d..cde3d2d25d 100644 --- a/docs/system/license.rst +++ b/docs/about/license.rst diff --git a/docs/system/removed-features.rst b/docs/about/removed-features.rst index 28bb035043..28bb035043 100644 --- a/docs/system/removed-features.rst +++ b/docs/about/removed-features.rst diff --git a/docs/conf.py b/docs/conf.py index 42729e22bb..ff6e92c6e2 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -87,7 +87,7 @@ master_doc = 'index' # General information about the project. project = u'QEMU' -copyright = u'2020, The QEMU Project Developers' +copyright = u'2021, The QEMU Project Developers' author = u'The QEMU Project Developers' # The version info for the project you're documenting, acts as replacement for diff --git a/docs/devel/index.rst b/docs/devel/index.rst index 40a7e2ee6f..153979caf4 100644 --- a/docs/devel/index.rst +++ b/docs/devel/index.rst @@ -1,15 +1,10 @@ -.. This is the top level page for the 'devel' manual. - - Developer Information ===================== -This manual documents various parts of the internals of QEMU. +This section of the manual documents various parts of the internals of QEMU. You only need to read it if you are interested in reading or modifying QEMU's source code. -Contents: - .. toctree:: :maxdepth: 2 :includehidden: diff --git a/docs/index.rst b/docs/index.rst index 763e3d0426..5f7eaaa632 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -10,6 +10,7 @@ Welcome to QEMU's documentation! :maxdepth: 2 :caption: Contents: + about/index system/index user/index tools/index diff --git a/docs/interop/index.rst b/docs/interop/index.rst index 219a5e5fc5..b1bab81e2e 100644 --- a/docs/interop/index.rst +++ b/docs/interop/index.rst @@ -1,13 +1,8 @@ -.. This is the top level page for the 'interop' manual. - - System Emulation Management and Interoperability ================================================ -This manual contains documents and specifications that are useful -for making QEMU interoperate with other software. - -Contents: +This section of the manual contains documents and specifications that +are useful for making QEMU interoperate with other software. .. toctree:: :maxdepth: 2 diff --git a/docs/meson.build b/docs/meson.build index 855e3916e9..300b134329 100644 --- a/docs/meson.build +++ b/docs/meson.build @@ -44,6 +44,7 @@ if build_docs meson.source_root() / 'docs/sphinx/qapidoc.py', meson.source_root() / 'docs/sphinx/qmp_lexer.py', qapi_gen_depends ] + sphinx_template_files = [ meson.source_root() / 'docs/_templates/footer.html' ] have_ga = have_tools and config_host.has_key('CONFIG_GUEST_AGENT') @@ -76,7 +77,7 @@ if build_docs output: 'docs.stamp', input: files('conf.py'), depfile: 'docs.d', - depend_files: sphinx_extn_depends, + depend_files: [ sphinx_extn_depends, sphinx_template_files ], command: [SPHINX_ARGS, '-Ddepfile=@DEPFILE@', '-Ddepfile_stamp=@OUTPUT0@', '-b', 'html', '-d', private_dir, diff --git a/docs/specs/index.rst b/docs/specs/index.rst index 7b08314d33..b7b08ea30d 100644 --- a/docs/specs/index.rst +++ b/docs/specs/index.rst @@ -1,11 +1,8 @@ -.. This is the top level page for the 'specs' manual - - System Emulation Guest Hardware Specifications ============================================== - -Contents: +This section of the manual contains specifications of +guest hardware that is specific to QEMU. .. toctree:: :maxdepth: 2 diff --git a/docs/system/arm/cubieboard.rst b/docs/system/arm/cubieboard.rst new file mode 100644 index 0000000000..344ff8cef9 --- /dev/null +++ b/docs/system/arm/cubieboard.rst @@ -0,0 +1,16 @@ +Cubietech Cubieboard (``cubieboard``) +===================================== + +The ``cubieboard`` model emulates the Cubietech Cubieboard, +which is a Cortex-A8 based single-board computer using +the AllWinner A10 SoC. + +Emulated devices: + +- Timer +- UART +- RTC +- EMAC +- SDHCI +- USB controller +- SATA controller diff --git a/docs/system/arm/emcraft-sf2.rst b/docs/system/arm/emcraft-sf2.rst new file mode 100644 index 0000000000..377e248720 --- /dev/null +++ b/docs/system/arm/emcraft-sf2.rst @@ -0,0 +1,15 @@ +Emcraft SmartFusion2 SOM kit (``emcraft-sf2``) +============================================== + +The ``emcraft-sf2`` board emulates the SmartFusion2 SOM kit from +Emcraft (M2S010). This is a System-on-Module from EmCraft systems, +based on the SmartFusion2 SoC FPGA from Microsemi Corporation. +The SoC is based on a Cortex-M4 processor. + +Emulated devices: + +- System timer +- System registers +- SPI controller +- UART +- EMAC diff --git a/docs/system/arm/highbank.rst b/docs/system/arm/highbank.rst new file mode 100644 index 0000000000..bb4965b367 --- /dev/null +++ b/docs/system/arm/highbank.rst @@ -0,0 +1,19 @@ +Calxeda Highbank and Midway (``highbank``, ``midway``) +====================================================== + +``highbank`` is a model of the Calxeda Highbank (ECX-1000) system, +which has four Cortex-A9 cores. + +``midway`` is a model of the Calxeda Midway (ECX-2000) system, +which has four Cortex-A15 cores. + +Emulated devices: + +- L2x0 cache controller +- SP804 dual timer +- PL011 UART +- PL061 GPIOs +- PL031 RTC +- PL022 synchronous serial port controller +- AHCI +- XGMAC ethernet controllers diff --git a/docs/system/index.rst b/docs/system/index.rst index 6092eb2d91..fda4b1b705 100644 --- a/docs/system/index.rst +++ b/docs/system/index.rst @@ -1,16 +1,11 @@ -.. This is the top level page for the 'system' manual. - - System Emulation ================ -This manual is the overall guide for users using QEMU +This section of the manual is the overall guide for users using QEMU for full system emulation (as opposed to user-mode emulation). This includes working with hypervisors such as KVM, Xen, Hax or Hypervisor.Framework. -Contents: - .. toctree:: :maxdepth: 3 @@ -40,7 +35,3 @@ Contents: targets security multi-process - deprecated - removed-features - build-platforms - license diff --git a/docs/system/target-arm.rst b/docs/system/target-arm.rst index 705b8835e4..c0c2585c0a 100644 --- a/docs/system/target-arm.rst +++ b/docs/system/target-arm.rst @@ -85,6 +85,9 @@ undocumented; you can get a complete list by running arm/aspeed arm/sabrelite arm/digic + arm/cubieboard + arm/emcraft-sf2 + arm/highbank arm/musicpal arm/gumstix arm/nrf diff --git a/docs/tools/index.rst b/docs/tools/index.rst index d923834a73..ef6041a490 100644 --- a/docs/tools/index.rst +++ b/docs/tools/index.rst @@ -1,11 +1,8 @@ -.. This is the top level page for the 'tools' manual - - Tools ===== - -Contents: +This section of the manual documents QEMU's "tools": its +command line utilities and other standalone programs. .. toctree:: :maxdepth: 2 diff --git a/docs/user/index.rst b/docs/user/index.rst index a5b47459ec..9faa4badd7 100644 --- a/docs/user/index.rst +++ b/docs/user/index.rst @@ -1,15 +1,10 @@ -.. This is the top level page for the 'user' manual. - - User Mode Emulation =================== -This manual is the overall guide for users using QEMU +This section of the manual is the overall guide for users using QEMU for user-mode emulation. In this mode, QEMU can launch processes compiled for one CPU on another CPU. -Contents: - .. toctree:: :maxdepth: 2 |