[PATCH] docs: rust: update description of crates

[PATCH] docs: rust: update description of crates

[Paolo Bonzini]

Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
---
 docs/devel/rust.rst | 14 ++++++++++----
 1 file changed, 10 insertions(+), 4 deletions(-)

diff --git a/docs/devel/rust.rst b/docs/devel/rust.rst
index 7964e1fd327..e3f9e16aacb 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:
+Right now 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 device 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.
 
-- 
2.48.1

Re: [PATCH] docs: rust: update description of crates

[Zhao Liu]

On Tue, Feb 18, 2025 at 09:04:55AM +0100, Paolo Bonzini wrote:
> Date: Tue, 18 Feb 2025 09:04:55 +0100
> From: Paolo Bonzini <pbonzini@redhat.com>
> Subject: [PATCH] docs: rust: update description of crates
> X-Mailer: git-send-email 2.48.1
> 
> Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
> ---
>  docs/devel/rust.rst | 14 ++++++++++----
>  1 file changed, 10 insertions(+), 4 deletions(-)
> 
> diff --git a/docs/devel/rust.rst b/docs/devel/rust.rst
> index 7964e1fd327..e3f9e16aacb 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:
> +Right now QEMU includes four crates:

Maybe we can avoid the words - "Right now"?

(It has been pointed out before that this type of wording is a bit too
vague. But, it's up to you.)

>  * ``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 device that demonstrate ``qemu_api`` and ``qemu_api_macros``, and are

s/device/devices/

> +  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.

An additional question, should I add the RUST HPET entry in MAINTAINERS file
under "PC Chipset" or add the new section like "ARM PL011 Rust device"?

I feel as if the former makes more sense?

>  This section explains how to work with them.
>

Overall, LGTM and thanks a lot,

Reviewed-by: Zhao Liu <zhao1.liu@intel.com>

Regards,
Zhao