aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPaolo Bonzini <pbonzini@redhat.com>2025-02-14 13:25:05 +0100
committerPaolo Bonzini <pbonzini@redhat.com>2025-02-25 16:18:11 +0100
commit29b9a66f9186f028ec46b58c9914d2da68c25c2c (patch)
tree03eaa7a8676c288b27d3338142bb0cbfa6ab8688
parent7a2e40866cf45a016858c73b9a5699b72be8ce38 (diff)
downloadqemu-29b9a66f9186f028ec46b58c9914d2da68c25c2c.zip
qemu-29b9a66f9186f028ec46b58c9914d2da68c25c2c.tar.gz
qemu-29b9a66f9186f028ec46b58c9914d2da68c25c2c.tar.bz2
docs: rust: update description of crates
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
-rw-r--r--docs/devel/rust.rst14
1 files changed, 10 insertions, 4 deletions
diff --git a/docs/devel/rust.rst b/docs/devel/rust.rst
index d68701c..5d8aa3a 100644
--- a/docs/devel/rust.rst
+++ b/docs/devel/rust.rst
@@ -139,16 +139,22 @@ anymore.
Writing Rust code in QEMU
-------------------------
-Right now QEMU includes three crates:
+QEMU includes four crates:
* ``qemu_api`` for bindings to C code and useful functionality
* ``qemu_api_macros`` defines several procedural macros that are useful when
writing C code
-* ``pl011`` (under ``rust/hw/char/pl011``) is the sample device that is being
- used to further develop ``qemu_api`` and ``qemu_api_macros``. It is a functional
- replacement for the ``hw/char/pl011.c`` file.
+* ``pl011`` (under ``rust/hw/char/pl011``) and ``hpet`` (under ``rust/hw/timer/hpet``)
+ are sample devices that demonstrate ``qemu_api`` and ``qemu_api_macros``, and are
+ used to further develop them. These two crates are functional\ [#issues]_ replacements
+ for the ``hw/char/pl011.c`` and ``hw/timer/hpet.c`` files.
+
+.. [#issues] The ``pl011`` crate is synchronized with ``hw/char/pl011.c``
+ as of commit 02b1f7f61928. The ``hpet`` crate is synchronized as of
+ commit f32352ff9e. Both are lacking tracing functionality; ``hpet``
+ is also lacking support for migration.
This section explains how to work with them.