| Message ID | 20250218080458.426402-1-pbonzini@redhat.com (mailing list archive) |
|---|---|
| State | New |
| Headers | show |
| Series | docs: rust: fix typos | expand |
On Tue, Feb 18, 2025 at 09:04:58AM +0100, Paolo Bonzini wrote: > Date: Tue, 18 Feb 2025 09:04:58 +0100 > From: Paolo Bonzini <pbonzini@redhat.com> > Subject: [PATCH] docs: rust: fix typos > X-Mailer: git-send-email 2.48.1 > > Signed-off-by: Paolo Bonzini <pbonzini@redhat.com> > --- > docs/devel/rust.rst | 4 ++-- > 1 file changed, 2 insertions(+), 2 deletions(-) Reviewed-by: Zhao Liu <zhao1.liu@intel.com>
On 18/2/25 09:04, Paolo Bonzini wrote: > Signed-off-by: Paolo Bonzini <pbonzini@redhat.com> > --- > docs/devel/rust.rst | 4 ++-- > 1 file changed, 2 insertions(+), 2 deletions(-) > By conventions, procedural macros are split in two functions, one > -returning ``Result<proc_macro2::TokenStream, MacroError>` with the body of > +returning ``Result<proc_macro2::TokenStream, MacroError>`` with the body of Isn't sphinx supposed to warn for such error?
diff --git a/docs/devel/rust.rst b/docs/devel/rust.rst index 90958e5a306..7964e1fd327 100644 --- a/docs/devel/rust.rst +++ b/docs/devel/rust.rst @@ -293,7 +293,7 @@ to a Rust mutable reference, and use a shared reference instead. Rust code will then have to use QEMU's ``BqlRefCell`` and ``BqlCell`` type, which enforce that locking rules for the "Big QEMU Lock" are respected. These cell types are also known to the ``vmstate`` crate, which is able to "look inside" -them when building an in-memory representation of a ``struct``s layout. +them when building an in-memory representation of a ``struct``'s layout. Note that the same is not true of a ``RefCell`` or ``Mutex``. In the future, similar cell types might also be provided for ``AioContext``-based @@ -349,7 +349,7 @@ Writing procedural macros ''''''''''''''''''''''''' By conventions, procedural macros are split in two functions, one -returning ``Result<proc_macro2::TokenStream, MacroError>` with the body of +returning ``Result<proc_macro2::TokenStream, MacroError>`` with the body of the procedural macro, and the second returning ``proc_macro::TokenStream`` which is the actual procedural macro. The former's name is the same as the latter with the ``_or_error`` suffix. The code for the latter is more
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com> --- docs/devel/rust.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)