index.rst 1.3 KB

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