xref: /qemu/docs/devel/index.rst (revision ff41da503089c6da3f7c4ffe534540ba8de81727)
106905f64SPaolo Bonzini---------------------
2816f93b2SMarc-André LureauDeveloper Information
306905f64SPaolo Bonzini---------------------
4f8cf7147SPeter Maydell
58b4528c8SAlex BennéeThis section of the manual documents various parts of the internals of
68b4528c8SAlex BennéeQEMU. You only need to read it if you are interested in reading or
7f8cf7147SPeter Maydellmodifying QEMU's source code.
8f8cf7147SPeter Maydell
98b4528c8SAlex BennéeQEMU is a large and mature project with a number of complex subsystems
108b4528c8SAlex Bennéethat can be overwhelming to understand. The development documentation
118b4528c8SAlex Bennéeis not comprehensive but hopefully presents enough to get you started.
128b4528c8SAlex BennéeIf there are areas that are unclear please reach out either via the
138b4528c8SAlex BennéeIRC channel or mailing list and hopefully we can improve the
148b4528c8SAlex Bennéedocumentation for future developers.
158b4528c8SAlex Bennée
168b4528c8SAlex BennéeAll developers will want to familiarise themselves with
178b4528c8SAlex Bennée:ref:`development_process` and how the community interacts. Please pay
188b4528c8SAlex Bennéeparticular attention to the :ref:`coding-style` and
198b4528c8SAlex Bennée:ref:`submitting-a-patch` sections to avoid common pitfalls.
208b4528c8SAlex Bennée
218b4528c8SAlex BennéeIf you wish to implement a new hardware model you will want to read
228b4528c8SAlex Bennéethrough the :ref:`qom` documentation to understand how QEMU's object
238b4528c8SAlex Bennéemodel works.
248b4528c8SAlex Bennée
258b4528c8SAlex BennéeThose wishing to enhance or add new CPU emulation capabilities will
268b4528c8SAlex Bennéewant to read our :ref:`tcg` documentation, especially the overview of
278b4528c8SAlex Bennéethe :ref:`tcg_internals`.
288b4528c8SAlex Bennée
29f8cf7147SPeter Maydell.. toctree::
30c6afd2bdSAlex Bennée   :maxdepth: 1
31c6afd2bdSAlex Bennée
32c6afd2bdSAlex Bennée   index-process
33c6afd2bdSAlex Bennée   index-build
34*ff41da50SThomas Huth   testing/index
35c6afd2bdSAlex Bennée   index-api
36c6afd2bdSAlex Bennée   index-internals
37c6afd2bdSAlex Bennée   index-tcg
38