[PATCH] rust: macros: fix documentation of the paste! macro

[PATCH] rust: macros: fix documentation of the paste! macro

[Paolo Bonzini]

One of the example in this section uses a curious mix of the constant
and function declaration syntaxes; fix it.

Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
---
 rust/macros/lib.rs | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/rust/macros/lib.rs b/rust/macros/lib.rs
index 520eae5fd792..d60359880b5a 100644
--- a/rust/macros/lib.rs
+++ b/rust/macros/lib.rs
@@ -322,7 +322,7 @@ pub fn pinned_drop(args: TokenStream, input: TokenStream) -> TokenStream {
 /// macro_rules! pub_no_prefix {
 ///     ($prefix:ident, $($newname:ident),+) => {
 ///         kernel::macros::paste! {
-///             $(pub(crate) const fn [<$newname:lower:span>]: u32 = [<$prefix $newname:span>];)+
+///             $(pub(crate) const fn [<$newname:lower:span>]() -> u32 { [<$prefix $newname:span>] })+
 ///         }
 ///     };
 /// }
-- 
2.46.2

Re: [PATCH] rust: macros: fix documentation of the paste! macro

[Alice Ryhl]

On Sat, Oct 19, 2024 at 9:22 AM Paolo Bonzini <pbonzini@redhat.com> wrote:
>
> One of the example in this section uses a curious mix of the constant
> and function declaration syntaxes; fix it.
>
> Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>

The `pub_no_prefix` examples usually defines constants rather than
functions. I guess it is a function here to showcase the :lower
modifier, which doesn't make sense for constants? I guess that makes
sense.

Reviewed-by: Alice Ryhl <aliceryhl@google.com>

Alice

Re: [PATCH] rust: macros: fix documentation of the paste! macro

[Miguel Ojeda]

On Sat, Oct 19, 2024 at 9:22 AM Paolo Bonzini <pbonzini@redhat.com> wrote:
>
> One of the example in this section uses a curious mix of the constant
> and function declaration syntaxes; fix it.
>
> Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>

Applied to `rust-next` -- thanks!

I will send a small series to fix a few other things in those examples.

Cheers,
Miguel