docs/devel: try and impose some organisation

We have a growing set of developer docs but the index is currently in
order of when stuff was added. Try and make things a bit easier to
find my adding sub indexes and organising into themes.

Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
Reviewed-by: Kashyap Chamarthy <kchamart@redhat.com>
Message-Id: <20220315121251.2280317-7-alex.bennee@linaro.org>
This commit is contained in:
Alex Bennée 2022-03-09 13:52:15 +00:00
parent b8003f9956
commit c6afd2bdfd
6 changed files with 95 additions and 39 deletions

15
docs/devel/index-api.rst Normal file
View File

@ -0,0 +1,15 @@
Internal QEMU APIs
------------------
Details about how QEMU's various internal APIs. Most of these are
generated from in-code annotations to function prototypes.
.. toctree::
:maxdepth: 2
:includehidden:
bitops
loads-stores
memory
modules
ui

View File

@ -0,0 +1,19 @@
QEMU Build and Test System
--------------------------
Details about how QEMU's build system works and how it is integrated
into our testing infrastructure. You will need to understand some of
the basics if you are adding new files and targets to the build.
.. toctree::
:maxdepth: 2
:includehidden:
build-system
kconfig
testing
qtest
ci
qapi-code-gen
fuzzing
control-flow-integrity

View File

@ -0,0 +1,21 @@
Internal Subsystem Information
------------------------------
Details about QEMU's various subsystems including how to add features to them.
.. toctree::
:maxdepth: 2
:includehidden:
qom
atomics
block-coroutine-wrapper
clocks
ebpf_rss
migration
multi-process
reset
s390-dasd-ipl
tracing
vfio-migration
writing-monitor-commands

View File

@ -0,0 +1,17 @@
QEMU Community Processes
------------------------
Notes about how to interact with the community and how and where to submit patches.
.. toctree::
:maxdepth: 2
:includehidden:
code-of-conduct
conflict-resolution
style
submitting-a-patch
trivial-patches
stable-process
submitting-a-pull-request
secure-coding-practices

16
docs/devel/index-tcg.rst Normal file
View File

@ -0,0 +1,16 @@
TCG Emulation
-------------
Details about QEMU's Tiny Code Generator and the infrastructure
associated with emulation. You do not need to worry about this if you
are only implementing things for HW accelerated hypervisors.
.. toctree::
:maxdepth: 2
:includehidden:
tcg
decodetree
multi-thread-tcg
tcg-icount
tcg-plugins

View File

@ -7,44 +7,12 @@ You only need to read it if you are interested in reading or
modifying QEMU's source code.
.. toctree::
:maxdepth: 2
:maxdepth: 1
: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-monitor-commands
trivial-patches
submitting-a-patch
submitting-a-pull-request
index-process
index-build
index-api
index-internals
index-tcg