rust: fix datatype in docs for `module` macro arguments
authorAswin Unnikrishnan <aswinunni01@gmail.com>
Sun, 12 May 2024 11:23:21 +0000 (11:23 +0000)
committerMiguel Ojeda <ojeda@kernel.org>
Mon, 8 Jul 2024 20:20:08 +0000 (22:20 +0200)
Remove the mention of byte array as datatype for `module` macro arguments
since the arguments are defined as string, and `alias` is a string array.

Signed-off-by: Aswin Unnikrishnan <aswinunni01@gmail.com>
Reviewed-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>
Reviewed-by: Benno Lossin <benno.lossin@proton.me>
Link: https://lore.kernel.org/r/20240512112324.8514-2-aswinunni01@gmail.com
Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
rust/macros/lib.rs

index aa89b41fa10e672306be16b0c412c7a615447910..5214e07367c5f45974688b6e67fd7ae02bdc13f2 100644 (file)
@@ -58,11 +58,11 @@ use proc_macro::TokenStream;
 ///
 /// # Supported argument types
 ///   - `type`: type which implements the [`Module`] trait (required).
-///   - `name`: byte array of the name of the kernel module (required).
-///   - `author`: byte array of the author of the kernel module.
-///   - `description`: byte array of the description of the kernel module.
-///   - `license`: byte array of the license of the kernel module (required).
-///   - `alias`: byte array of alias name of the kernel module.
+///   - `name`: ASCII string literal of the name of the kernel module (required).
+///   - `author`: string literal of the author of the kernel module.
+///   - `description`: string literal of the description of the kernel module.
+///   - `license`: ASCII string literal of the license of the kernel module (required).
+///   - `alias`: array of ASCII string literals of the alias names of the kernel module.
 #[proc_macro]
 pub fn module(ts: TokenStream) -> TokenStream {
     module::module(ts)