xemu/docs/tools/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

18 lines
281 B
ReStructuredText

-----
Tools
-----
This section of the manual documents QEMU's "tools": its
command line utilities and other standalone programs.
.. toctree::
:maxdepth: 2
qemu-img
qemu-storage-daemon
qemu-nbd
qemu-pr-helper
qemu-trace-stap
virtfs-proxy-helper
virtiofsd