From: Aswin Unnikrishnan <aswinunni01@gmail.com>
Date: Sun, 12 May 2024 11:23:20 +0000 (+0000)
Subject: rust: add example for `alias` argument in `module` macro documentation
X-Git-Tag: v6.11-rc1~12^2~25
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=67f9c312b0a7f4bc869376d2a68308e673235954;p=thirdparty%2Fkernel%2Flinux.git

rust: add example for `alias` argument in `module` macro documentation

Add example for `alias` argument supported by `module` macro.
`alias` accepts an array of alternate names for the module as string.

Reviewed-by: Alice Ryhl <aliceryhl@google.com>
Signed-off-by: Aswin Unnikrishnan <aswinunni01@gmail.com>
Reviewed-by: Benno Lossin <benno.lossin@proton.me>
Link: https://lore.kernel.org/r/20240512112324.8514-1-aswinunni01@gmail.com
Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
---

diff --git a/rust/macros/lib.rs b/rust/macros/lib.rs
index 520eae5fd7928..aa89b41fa10e6 100644
--- a/rust/macros/lib.rs
+++ b/rust/macros/lib.rs
@@ -35,6 +35,7 @@ use proc_macro::TokenStream;
 ///     author: "Rust for Linux Contributors",
 ///     description: "My very own kernel module!",
 ///     license: "GPL",
+///     alias: ["alternate_module_name"],
 /// }
 ///
 /// struct MyModule;