[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v4 22/38] docs/devel: add some front matter to the devel index
From: |
Alex Bennée |
Subject: |
[PATCH v4 22/38] docs/devel: add some front matter to the devel index |
Date: |
Fri, 30 Jun 2023 19:04:07 +0100 |
Give an overview of the most useful bits of the devel documentation to
read depending on what the developer wants to do.
Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
Reviewed-by: Richard Henderson <richard.henderson@linaro.org>
Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org>
Message-Id: <20230623122100.1640995-22-alex.bennee@linaro.org>
---
v2
- removed excessive start
---
docs/devel/index-process.rst | 2 ++
docs/devel/index-tcg.rst | 2 ++
docs/devel/index.rst | 24 ++++++++++++++++++++++--
docs/devel/tcg.rst | 2 ++
4 files changed, 28 insertions(+), 2 deletions(-)
diff --git a/docs/devel/index-process.rst b/docs/devel/index-process.rst
index d50dd74c3e..362f97ee30 100644
--- a/docs/devel/index-process.rst
+++ b/docs/devel/index-process.rst
@@ -1,3 +1,5 @@
+.. _development_process:
+
QEMU Community Processes
------------------------
diff --git a/docs/devel/index-tcg.rst b/docs/devel/index-tcg.rst
index b44ff8b5a4..a992844e5c 100644
--- a/docs/devel/index-tcg.rst
+++ b/docs/devel/index-tcg.rst
@@ -1,3 +1,5 @@
+.. _tcg:
+
TCG Emulation
-------------
diff --git a/docs/devel/index.rst b/docs/devel/index.rst
index 09cfb322be..abf60457c2 100644
--- a/docs/devel/index.rst
+++ b/docs/devel/index.rst
@@ -2,10 +2,30 @@
Developer Information
---------------------
-This section of the manual documents various parts of the internals of QEMU.
-You only need to read it if you are interested in reading or
+This section of the manual documents various parts of the internals of
+QEMU. You only need to read it if you are interested in reading or
modifying QEMU's source code.
+QEMU is a large and mature project with a number of complex subsystems
+that can be overwhelming to understand. The development documentation
+is not comprehensive but hopefully presents enough to get you started.
+If there are areas that are unclear please reach out either via the
+IRC channel or mailing list and hopefully we can improve the
+documentation for future developers.
+
+All developers will want to familiarise themselves with
+:ref:`development_process` and how the community interacts. Please pay
+particular attention to the :ref:`coding-style` and
+:ref:`submitting-a-patch` sections to avoid common pitfalls.
+
+If you wish to implement a new hardware model you will want to read
+through the :ref:`qom` documentation to understand how QEMU's object
+model works.
+
+Those wishing to enhance or add new CPU emulation capabilities will
+want to read our :ref:`tcg` documentation, especially the overview of
+the :ref:`tcg_internals`.
+
.. toctree::
:maxdepth: 1
diff --git a/docs/devel/tcg.rst b/docs/devel/tcg.rst
index b4096a17df..2786f2f679 100644
--- a/docs/devel/tcg.rst
+++ b/docs/devel/tcg.rst
@@ -1,3 +1,5 @@
+.. _tcg_internals:
+
====================
Translator Internals
====================
--
2.39.2
- [PATCH v4 34/38] gdbstub: Expose gdb_get_process() and gdb_get_first_cpu_in_process(), (continued)
- [PATCH v4 34/38] gdbstub: Expose gdb_get_process() and gdb_get_first_cpu_in_process(), Alex Bennée, 2023/06/30
- [PATCH v4 17/38] tests/avocado: Make the test_arm_bpim2u_gmac test more reliable, Alex Bennée, 2023/06/30
- [PATCH v4 29/38] gdbstub: Permit reverse step/break to provide stop response, Alex Bennée, 2023/06/30
- [PATCH v4 35/38] gdbstub: Report the actual qemu-user pid, Alex Bennée, 2023/06/30
- [PATCH v4 31/38] linux-user: Expose do_guest_openat() and do_guest_readlink(), Alex Bennée, 2023/06/30
- [PATCH v4 16/38] tests/avocado: update firmware to enable sbsa-ref/max, Alex Bennée, 2023/06/30
- [PATCH v4 24/38] include/hw/qdev-core: fixup kerneldoc annotations, Alex Bennée, 2023/06/30
- [PATCH v4 15/38] tests/docker: convert riscv64-cross to lcitool, Alex Bennée, 2023/06/30
- [PATCH v4 18/38] target/arm: make arm_casq_ptw CONFIG_TCG only, Alex Bennée, 2023/06/30
- [PATCH v4 23/38] include/migration: mark vmstate_register() as a legacy function, Alex Bennée, 2023/06/30
- [PATCH v4 22/38] docs/devel: add some front matter to the devel index,
Alex Bennée <=
- [PATCH v4 19/38] plugins: force slow path when plugins instrument memory ops, Alex Bennée, 2023/06/30