xref: /openbmc/qemu/docs/devel/index.rst (revision 4921d0a7)
1---------------------
2Developer Information
3---------------------
4
5This section of the manual documents various parts of the internals of
6QEMU. You only need to read it if you are interested in reading or
7modifying QEMU's source code.
8
9QEMU is a large and mature project with a number of complex subsystems
10that can be overwhelming to understand. The development documentation
11is not comprehensive but hopefully presents enough to get you started.
12If there are areas that are unclear please reach out either via the
13IRC channel or mailing list and hopefully we can improve the
14documentation for future developers.
15
16All developers will want to familiarise themselves with
17:ref:`development_process` and how the community interacts. Please pay
18particular attention to the :ref:`coding-style` and
19:ref:`submitting-a-patch` sections to avoid common pitfalls.
20
21If you wish to implement a new hardware model you will want to read
22through the :ref:`qom` documentation to understand how QEMU's object
23model works.
24
25Those wishing to enhance or add new CPU emulation capabilities will
26want to read our :ref:`tcg` documentation, especially the overview of
27the :ref:`tcg_internals`.
28
29.. toctree::
30   :maxdepth: 1
31
32   index-process
33   index-build
34   index-api
35   index-internals
36   index-tcg
37