Commit 63249a07 authored by Aswin Unnikrishnan's avatar Aswin Unnikrishnan Committed by Miguel Ojeda
Browse files

rust: fix datatype in docs for `module` macro arguments 



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: default avatarAswin Unnikrishnan <aswinunni01@gmail.com>
Reviewed-by: default avatarVincenzo Palazzo <vincenzopalazzodev@gmail.com>
Reviewed-by: default avatarBenno Lossin <benno.lossin@proton.me>
Link: https://lore.kernel.org/r/20240512112324.8514-2-aswinunni01@gmail.com


Signed-off-by: default avatarMiguel Ojeda <ojeda@kernel.org>
parent 67f9c312

rust/macros/lib.rs

+5 −5
Original line number Diff line number Diff line
@@ -58,11 +58,11 @@ 
///

/// # 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)