rust-for-linux.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Aswin Unnikrishnan <aswinunni01@gmail.com>
To: Miguel Ojeda <ojeda@kernel.org>,
	Alex Gaynor <alex.gaynor@gmail.com>,
	Wedson Almeida Filho <wedsonaf@gmail.com>
Cc: "Boqun Feng" <boqun.feng@gmail.com>,
	"Gary Guo" <gary@garyguo.net>,
	"Björn Roy Baron" <bjorn3_gh@protonmail.com>,
	"Benno Lossin" <benno.lossin@proton.me>,
	"Andreas Hindborg" <a.hindborg@samsung.com>,
	"Alice Ryhl" <aliceryhl@google.com>,
	rust-for-linux@vger.kernel.org,
	"Aswin Unnikrishnan" <aswinunni01@gmail.com>
Subject: [PATCH 3/3] rust: fix datatype in docs for `module` macro arguments
Date: Fri, 19 Apr 2024 21:50:15 +0000	[thread overview]
Message-ID: <20240419215015.157258-3-aswinunni01@gmail.com> (raw)
In-Reply-To: <20240419215015.157258-1-aswinunni01@gmail.com>

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>
---
 rust/macros/lib.rs | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/rust/macros/lib.rs b/rust/macros/lib.rs
index aa89b41fa10e..da7cd6378288 100644
--- a/rust/macros/lib.rs
+++ b/rust/macros/lib.rs
@@ -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`: name of the kernel module (required).
+///   - `author`: author of the kernel module.
+///   - `description`: description of the kernel module.
+///   - `license`: license of the kernel module (required).
+///   - `alias`: array of alias names of the kernel module.
 #[proc_macro]
 pub fn module(ts: TokenStream) -> TokenStream {
     module::module(ts)
-- 
2.34.1


  parent reply	other threads:[~2024-04-19 21:50 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-04-19 21:50 [PATCH 1/3] rust: remove `params` from `module` macro docs Aswin Unnikrishnan
2024-04-19 21:50 ` [PATCH 2/3] rust: add example for `alias` argument in `module` macro documentation Aswin Unnikrishnan
2024-04-22  6:05   ` Alice Ryhl
2024-04-19 21:50 ` Aswin Unnikrishnan [this message]
2024-04-22  6:05   ` [PATCH 3/3] rust: fix datatype in docs for `module` macro arguments Alice Ryhl
2024-04-23  0:46   ` Miguel Ojeda
2024-04-22  6:05 ` [PATCH 1/3] rust: remove `params` from `module` macro docs Alice Ryhl
2024-04-23  0:43 ` Miguel Ojeda

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20240419215015.157258-3-aswinunni01@gmail.com \
    --to=aswinunni01@gmail.com \
    --cc=a.hindborg@samsung.com \
    --cc=alex.gaynor@gmail.com \
    --cc=aliceryhl@google.com \
    --cc=benno.lossin@proton.me \
    --cc=bjorn3_gh@protonmail.com \
    --cc=boqun.feng@gmail.com \
    --cc=gary@garyguo.net \
    --cc=ojeda@kernel.org \
    --cc=rust-for-linux@vger.kernel.org \
    --cc=wedsonaf@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).