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