Skip to content

Commit 63249a0

Browse files
aswinunni01ojeda
authored andcommitted
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: 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>
1 parent 67f9c31 commit 63249a0

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

rust/macros/lib.rs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -58,11 +58,11 @@ use proc_macro::TokenStream;
5858
///
5959
/// # Supported argument types
6060
/// - `type`: type which implements the [`Module`] trait (required).
61-
/// - `name`: byte array of the name of the kernel module (required).
62-
/// - `author`: byte array of the author of the kernel module.
63-
/// - `description`: byte array of the description of the kernel module.
64-
/// - `license`: byte array of the license of the kernel module (required).
65-
/// - `alias`: byte array of alias name of the kernel module.
61+
/// - `name`: ASCII string literal of the name of the kernel module (required).
62+
/// - `author`: string literal of the author of the kernel module.
63+
/// - `description`: string literal of the description of the kernel module.
64+
/// - `license`: ASCII string literal of the license of the kernel module (required).
65+
/// - `alias`: array of ASCII string literals of the alias names of the kernel module.
6666
#[proc_macro]
6767
pub fn module(ts: TokenStream) -> TokenStream {
6868
module::module(ts)

0 commit comments

Comments
 (0)