qemu-e2k/docs/system/index.rst
Paolo Bonzini 06905f6402 docs: standardize directory index to --- with overline
Use a standard heading format for the index.rst file in a directory.
Using overlines makes it clear that individual documents can use e.g.
=== for chapter titles and --- for section titles, as suggested in the
Linux kernel guidelines[1].  They could do it anyway, because documents
included in a toctree are parsed separately and therefore are not tied
to the same conventions for headings.  However, keeping some consistency is
useful since sometimes files are included from multiple places.

[1] https://www.kernel.org/doc/html/latest/doc-guide/sphinx.html

Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
2021-09-13 13:56:26 +02:00

37 lines
625 B
ReStructuredText

----------------
System Emulation
----------------
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.
.. toctree::
:maxdepth: 3
quickstart
invocation
device-emulation
keys
mux-chardev
monitor
images
virtio-net-failover
linuxboot
generic-loader
guest-loader
barrier
vnc-security
tls
secrets
authz
gdb
managed-startup
bootindex
cpu-hotplug
pr-manager
targets
security
multi-process