Rust-for-linux archive mirror
 help / color / mirror / Atom feed

From: Miguel Ojeda <miguel.ojeda.sandonis@gmail.com>
To: Aswin Unnikrishnan <aswinunni01@gmail.com>
Cc: "Miguel Ojeda" <ojeda@kernel.org>,
	"Alex Gaynor" <alex.gaynor@gmail.com>,
	"Wedson Almeida Filho" <wedsonaf@gmail.com>,
	"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
Subject: Re: [PATCH 3/3] rust: fix datatype in docs for `module` macro arguments
Date: Tue, 23 Apr 2024 02:46:41 +0200	[thread overview]
Message-ID: <CANiq72=g4f60n8x=-fCxqQ4QzD2eOrEb=vEXgoNidY-N4omN1A@mail.gmail.com> (raw)
In-Reply-To: <20240419215015.157258-3-aswinunni01@gmail.com>

On Fri, Apr 19, 2024 at 11:50 PM Aswin Unnikrishnan
<aswinunni01@gmail.com> wrote:
>
>  /// # 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.

I think the original intention here was to document mainly the "type"
of the arguments (given the title of the section), i.e. the kind of
values one can write for each key.

So it would perhaps be best to give that information, e.g. "ASCII
string literal ...". Please see the code of the macro to see which
type is required for each field (e.g. is it a literal? Does it require
ASCII? ...?).

This should probably be considered a fix, so could you please add a
`Fixes:` tag and a `Cc: stable@vger.kernel.org` one in v2 (since it
does not hurt)? See e.g. what I did for your other fix I applied
already to `rust-fixes` (but note it fixes a different commit) and
https://docs.kernel.org/process/submitting-patches.html#describe-your-changes.

Thanks!

Cheers,
Miguel

next prev parent reply	other threads:[~2024-04-23  0:47 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 ` [PATCH 3/3] rust: fix datatype in docs for `module` macro arguments Aswin Unnikrishnan
2024-04-22  6:05   ` Alice Ryhl
2024-04-23  0:46   ` Miguel Ojeda [this message]
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='CANiq72=g4f60n8x=-fCxqQ4QzD2eOrEb=vEXgoNidY-N4omN1A@mail.gmail.com' \
    --to=miguel.ojeda.sandonis@gmail.com \
    --cc=a.hindborg@samsung.com \
    --cc=alex.gaynor@gmail.com \
    --cc=aliceryhl@google.com \
    --cc=aswinunni01@gmail.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

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 read-only IMAP folder(s) and NNTP newsgroup(s).