qemu/docs/devel/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

48 lines
787 B
ReStructuredText

---------------------
Developer Information
---------------------
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.
.. toctree::
:maxdepth: 2
:includehidden:
code-of-conduct
conflict-resolution
build-system
style
kconfig
testing
fuzzing
control-flow-integrity
loads-stores
memory
migration
atomics
stable-process
ci
qtest
decodetree
secure-coding-practices
tcg
tcg-icount
tracing
multi-thread-tcg
tcg-plugins
bitops
ui
reset
s390-dasd-ipl
clocks
qom
modules
block-coroutine-wrapper
multi-process
ebpf_rss
vfio-migration
qapi-code-gen
writing-qmp-commands