[PATCH] rust: module: remove deprecated author key

[PATCH] rust: module: remove deprecated author key

[Guilherme Giacomo Simoes]

Commit 38559da6afb2 ("rust: module: introduce `authors` key") introduced
a new `authors` key to support multiple module authors, while keeping
the old `author` key for backward compatibility.

Now that all in-tree modules have migrated to `authors`, remove:
1. The deprecated `author` key support from the module macro
2. Legacy `author` entries from remaining modules

Signed-off-by: Guilherme Giacomo Simoes <trintaeoitogc@gmail.com>
---
 drivers/cpufreq/rcpufreq_dt.rs        | 2 +-
 drivers/gpu/drm/nova/nova.rs          | 2 +-
 drivers/gpu/nova-core/nova_core.rs    | 2 +-
 rust/kernel/firmware.rs               | 2 +-
 rust/macros/module.rs                 | 6 ------
 samples/rust/rust_configfs.rs         | 2 +-
 samples/rust/rust_driver_auxiliary.rs | 2 +-
 7 files changed, 6 insertions(+), 12 deletions(-)

diff --git a/drivers/cpufreq/rcpufreq_dt.rs b/drivers/cpufreq/rcpufreq_dt.rs
index 94ed81644fe1..bdf4b844de42 100644
--- a/drivers/cpufreq/rcpufreq_dt.rs
+++ b/drivers/cpufreq/rcpufreq_dt.rs
@@ -220,7 +220,7 @@ fn probe(
 module_platform_driver! {
     type: CPUFreqDTDriver,
     name: "cpufreq-dt",
-    author: "Viresh Kumar <viresh.kumar@linaro.org>",
+    authors: ["Viresh Kumar <viresh.kumar@linaro.org>"],
     description: "Generic CPUFreq DT driver",
     license: "GPL v2",
 }
diff --git a/drivers/gpu/drm/nova/nova.rs b/drivers/gpu/drm/nova/nova.rs
index 902876aa14d1..64fd670e99e1 100644
--- a/drivers/gpu/drm/nova/nova.rs
+++ b/drivers/gpu/drm/nova/nova.rs
@@ -12,7 +12,7 @@
 kernel::module_auxiliary_driver! {
     type: NovaDriver,
     name: "Nova",
-    author: "Danilo Krummrich",
+    authors: ["Danilo Krummrich"],
     description: "Nova GPU driver",
     license: "GPL v2",
 }
diff --git a/drivers/gpu/nova-core/nova_core.rs b/drivers/gpu/nova-core/nova_core.rs
index 618632f0abcc..f405d7a99c28 100644
--- a/drivers/gpu/nova-core/nova_core.rs
+++ b/drivers/gpu/nova-core/nova_core.rs
@@ -13,7 +13,7 @@
 kernel::module_pci_driver! {
     type: driver::NovaCore,
     name: "NovaCore",
-    author: "Danilo Krummrich",
+    authors: ["Danilo Krummrich"],
     description: "Nova Core GPU driver",
     license: "GPL v2",
     firmware: [],
diff --git a/rust/kernel/firmware.rs b/rust/kernel/firmware.rs
index 2494c96e105f..ed2fc20cba9b 100644
--- a/rust/kernel/firmware.rs
+++ b/rust/kernel/firmware.rs
@@ -181,7 +181,7 @@ unsafe impl Sync for Firmware {}
 /// module! {
 ///    type: MyModule,
 ///    name: "module_firmware_test",
-///    author: "Rust for Linux",
+///    authors: ["Rust for Linux"],
 ///    description: "module_firmware! test module",
 ///    license: "GPL",
 /// }
diff --git a/rust/macros/module.rs b/rust/macros/module.rs
index 2ddd2eeb2852..5dd276a2e5cb 100644
--- a/rust/macros/module.rs
+++ b/rust/macros/module.rs
@@ -94,7 +94,6 @@ struct ModuleInfo {
     type_: String,
     license: String,
     name: String,
-    author: Option<String>,
     authors: Option<Vec<String>>,
     description: Option<String>,
     alias: Option<Vec<String>>,
@@ -108,7 +107,6 @@ fn parse(it: &mut token_stream::IntoIter) -> Self {
         const EXPECTED_KEYS: &[&str] = &[
             "type",
             "name",
-            "author",
             "authors",
             "description",
             "license",
@@ -134,7 +132,6 @@ fn parse(it: &mut token_stream::IntoIter) -> Self {
             match key.as_str() {
                 "type" => info.type_ = expect_ident(it),
                 "name" => info.name = expect_string_ascii(it),
-                "author" => info.author = Some(expect_string(it)),
                 "authors" => info.authors = Some(expect_string_array(it)),
                 "description" => info.description = Some(expect_string(it)),
                 "license" => info.license = expect_string_ascii(it),
@@ -179,9 +176,6 @@ pub(crate) fn module(ts: TokenStream) -> TokenStream {
     // Rust does not allow hyphens in identifiers, use underscore instead.
     let ident = info.name.replace('-', "_");
     let mut modinfo = ModInfoBuilder::new(ident.as_ref());
-    if let Some(author) = info.author {
-        modinfo.emit("author", &author);
-    }
     if let Some(authors) = info.authors {
         for author in authors {
             modinfo.emit("author", &author);
diff --git a/samples/rust/rust_configfs.rs b/samples/rust/rust_configfs.rs
index 60ddbe62cda3..af04bfa35cb2 100644
--- a/samples/rust/rust_configfs.rs
+++ b/samples/rust/rust_configfs.rs
@@ -14,7 +14,7 @@
 module! {
     type: RustConfigfs,
     name: "rust_configfs",
-    author: "Rust for Linux Contributors",
+    authors: ["Rust for Linux Contributors"],
     description: "Rust configfs sample",
     license: "GPL",
 }
diff --git a/samples/rust/rust_driver_auxiliary.rs b/samples/rust/rust_driver_auxiliary.rs
index 3e15e6d002bb..abf3d55ed249 100644
--- a/samples/rust/rust_driver_auxiliary.rs
+++ b/samples/rust/rust_driver_auxiliary.rs
@@ -114,7 +114,7 @@ fn init(module: &'static kernel::ThisModule) -> impl PinInit<Self, Error> {
 module! {
     type: SampleModule,
     name: "rust_driver_auxiliary",
-    author: "Danilo Krummrich",
+    authors: ["Danilo Krummrich"],
     description: "Rust auxiliary driver",
     license: "GPL v2",
 }
-- 
2.34.1

Re: [PATCH] rust: module: remove deprecated author key

[Miguel Ojeda]

On Mon, Jun 9, 2025 at 2:22 PM Guilherme Giacomo Simoes
<trintaeoitogc@gmail.com> wrote:
>
> Now that all in-tree modules have migrated to `authors`, remove:

Nit: I would have said "most modules", since we have new/remaining
ones (no need for a new version for this).

I think this patch is OK -- we could wait to do this more cycles, but
if we are doing it, then probably the sooner we do it, the simpler.

>  drivers/cpufreq/rcpufreq_dt.rs        | 2 +-
>  drivers/gpu/drm/nova/nova.rs          | 2 +-
>  drivers/gpu/nova-core/nova_core.rs    | 2 +-
>  rust/kernel/firmware.rs               | 2 +-
>  samples/rust/rust_configfs.rs         | 2 +-
>  samples/rust/rust_driver_auxiliary.rs | 2 +-

Andreas, Danilo, Greg, Viresh: if nobody is against it, I will apply
it this cycle. Acked-by's for your bits appreciated, of course.

Thanks!

Cheers,
Miguel

Re: [PATCH] rust: module: remove deprecated author key

[Danilo Krummrich]

On 09.06.2025 19:39, Miguel Ojeda wrote:
> On Mon, Jun 9, 2025 at 2:22 PM Guilherme Giacomo Simoes
> <trintaeoitogc@gmail.com> wrote:
>>
>> Now that all in-tree modules have migrated to `authors`, remove:
> 
> Nit: I would have said "most modules", since we have new/remaining
> ones (no need for a new version for this).
> 
> I think this patch is OK -- we could wait to do this more cycles, but
> if we are doing it, then probably the sooner we do it, the simpler.
> 
>>  drivers/cpufreq/rcpufreq_dt.rs        | 2 +-
>>  drivers/gpu/drm/nova/nova.rs          | 2 +-
>>  drivers/gpu/nova-core/nova_core.rs    | 2 +-
>>  rust/kernel/firmware.rs               | 2 +-
>>  samples/rust/rust_configfs.rs         | 2 +-
>>  samples/rust/rust_driver_auxiliary.rs | 2 +-
> 
> Andreas, Danilo, Greg, Viresh: if nobody is against it, I will apply
> it this cycle. Acked-by's for your bits appreciated, of course.

Acked-by: Danilo Krummrich <dakr@kernel.org>

Re: [PATCH] rust: module: remove deprecated author key

[Viresh Kumar]

On 09-06-25, 09:22, Guilherme Giacomo Simoes wrote:
> Commit 38559da6afb2 ("rust: module: introduce `authors` key") introduced
> a new `authors` key to support multiple module authors, while keeping
> the old `author` key for backward compatibility.
> 
> Now that all in-tree modules have migrated to `authors`, remove:
> 1. The deprecated `author` key support from the module macro
> 2. Legacy `author` entries from remaining modules
> 
> Signed-off-by: Guilherme Giacomo Simoes <trintaeoitogc@gmail.com>
> ---
>  drivers/cpufreq/rcpufreq_dt.rs        | 2 +-
 
> diff --git a/drivers/cpufreq/rcpufreq_dt.rs b/drivers/cpufreq/rcpufreq_dt.rs
> index 94ed81644fe1..bdf4b844de42 100644
> --- a/drivers/cpufreq/rcpufreq_dt.rs
> +++ b/drivers/cpufreq/rcpufreq_dt.rs
> @@ -220,7 +220,7 @@ fn probe(
>  module_platform_driver! {
>      type: CPUFreqDTDriver,
>      name: "cpufreq-dt",
> -    author: "Viresh Kumar <viresh.kumar@linaro.org>",
> +    authors: ["Viresh Kumar <viresh.kumar@linaro.org>"],
>      description: "Generic CPUFreq DT driver",
>      license: "GPL v2",
>  }

Acked-by: Viresh Kumar <viresh.kumar@linaro.org>

-- 
viresh

Re: [PATCH] rust: module: remove deprecated author key

[Andreas Hindborg]

"Guilherme Giacomo Simoes" <trintaeoitogc@gmail.com> writes:

> Commit 38559da6afb2 ("rust: module: introduce `authors` key") introduced
> a new `authors` key to support multiple module authors, while keeping
> the old `author` key for backward compatibility.
>
> Now that all in-tree modules have migrated to `authors`, remove:
> 1. The deprecated `author` key support from the module macro
> 2. Legacy `author` entries from remaining modules
>
> Signed-off-by: Guilherme Giacomo Simoes <trintaeoitogc@gmail.com>


Acked-by: Andreas Hindborg <a.hindborg@kernel.org>


Best regards,
Andreas Hindborg

Re: [PATCH] rust: module: remove deprecated author key

[Benno Lossin]

On Mon Jun 9, 2025 at 2:22 PM CEST, Guilherme Giacomo Simoes wrote:
> Commit 38559da6afb2 ("rust: module: introduce `authors` key") introduced
> a new `authors` key to support multiple module authors, while keeping
> the old `author` key for backward compatibility.
>
> Now that all in-tree modules have migrated to `authors`, remove:
> 1. The deprecated `author` key support from the module macro
> 2. Legacy `author` entries from remaining modules
>
> Signed-off-by: Guilherme Giacomo Simoes <trintaeoitogc@gmail.com>
> ---
>  drivers/cpufreq/rcpufreq_dt.rs        | 2 +-
>  drivers/gpu/drm/nova/nova.rs          | 2 +-
>  drivers/gpu/nova-core/nova_core.rs    | 2 +-
>  rust/kernel/firmware.rs               | 2 +-
>  rust/macros/module.rs                 | 6 ------
>  samples/rust/rust_configfs.rs         | 2 +-
>  samples/rust/rust_driver_auxiliary.rs | 2 +-
>  7 files changed, 6 insertions(+), 12 deletions(-)

Reviewed-by: Benno Lossin <lossin@kernel.org>

---
Cheers,
Benno

Re: [PATCH] rust: module: remove deprecated author key

[Benno Lossin]

On Mon Jun 9, 2025 at 2:22 PM CEST, Guilherme Giacomo Simoes wrote:
> diff --git a/drivers/gpu/nova-core/nova_core.rs b/drivers/gpu/nova-core/nova_core.rs
> index 618632f0abcc..f405d7a99c28 100644
> --- a/drivers/gpu/nova-core/nova_core.rs
> +++ b/drivers/gpu/nova-core/nova_core.rs
> @@ -13,7 +13,7 @@
>  kernel::module_pci_driver! {
>      type: driver::NovaCore,
>      name: "NovaCore",
> -    author: "Danilo Krummrich",
> +    authors: ["Danilo Krummrich"],

Unrelated to this change, I think we should add email addresses to
people in authors. Possibly enforce it by scanning each author element
and checking if there is an email address.

>      description: "Nova Core GPU driver",
>      license: "GPL v2",
>      firmware: [],
> diff --git a/rust/kernel/firmware.rs b/rust/kernel/firmware.rs
> index 2494c96e105f..ed2fc20cba9b 100644
> --- a/rust/kernel/firmware.rs
> +++ b/rust/kernel/firmware.rs
> @@ -181,7 +181,7 @@ unsafe impl Sync for Firmware {}
>  /// module! {
>  ///    type: MyModule,
>  ///    name: "module_firmware_test",
> -///    author: "Rust for Linux",
> +///    authors: ["Rust for Linux"],

We would need to special case "Rust for Linux Developers" or something
similar. But in several cases -- such as this one, we should just name
the actual authors.

What do you guys think?

---
Cheers,
Benno

Re: [PATCH] rust: module: remove deprecated author key

[Greg KH]

On Mon, Jun 09, 2025 at 07:47:55PM +0200, Danilo Krummrich wrote:
> On 09.06.2025 19:39, Miguel Ojeda wrote:
> > On Mon, Jun 9, 2025 at 2:22 PM Guilherme Giacomo Simoes
> > <trintaeoitogc@gmail.com> wrote:
> >>
> >> Now that all in-tree modules have migrated to `authors`, remove:
> > 
> > Nit: I would have said "most modules", since we have new/remaining
> > ones (no need for a new version for this).
> > 
> > I think this patch is OK -- we could wait to do this more cycles, but
> > if we are doing it, then probably the sooner we do it, the simpler.
> > 
> >>  drivers/cpufreq/rcpufreq_dt.rs        | 2 +-
> >>  drivers/gpu/drm/nova/nova.rs          | 2 +-
> >>  drivers/gpu/nova-core/nova_core.rs    | 2 +-
> >>  rust/kernel/firmware.rs               | 2 +-
> >>  samples/rust/rust_configfs.rs         | 2 +-
> >>  samples/rust/rust_driver_auxiliary.rs | 2 +-
> > 
> > Andreas, Danilo, Greg, Viresh: if nobody is against it, I will apply
> > it this cycle. Acked-by's for your bits appreciated, of course.
> 
> Acked-by: Danilo Krummrich <dakr@kernel.org>

Acked-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

Re: [PATCH] rust: module: remove deprecated author key

[Miguel Ojeda]

On Tue, Jun 10, 2025 at 10:58 AM Benno Lossin <lossin@kernel.org> wrote:
>
> Unrelated to this change, I think we should add email addresses to
> people in authors. Possibly enforce it by scanning each author element
> and checking if there is an email address.

Sounds good to me, but I am not sure if it is possible in all cases.

At least looking at C, there are company names too.

I even saw a URL...

Cheers,
Miguel

Re: [PATCH] rust: module: remove deprecated author key

[Miguel Ojeda]

On Tue, Jun 10, 2025 at 12:03 PM Miguel Ojeda
<miguel.ojeda.sandonis@gmail.com> wrote:
>
> I even saw a URL...

i.e. as the sole thing, not as an addition to a company name:

    MODULE_AUTHOR("https://www.comedi.org");

Perhaps we could have a new key or similar for companies/entities, but
I am not sure if it is important, and we should probably do it in the
C side too in that case.

After all, we can get contact details from the Git log, `MAINTAINERS`, etc.

Cheers,
Miguel

Re: [PATCH] rust: module: remove deprecated author key

[Benno Lossin]

On Tue Jun 10, 2025 at 12:03 PM CEST, Miguel Ojeda wrote:
> On Tue, Jun 10, 2025 at 10:58 AM Benno Lossin <lossin@kernel.org> wrote:
>>
>> Unrelated to this change, I think we should add email addresses to
>> people in authors. Possibly enforce it by scanning each author element
>> and checking if there is an email address.
>
> Sounds good to me, but I am not sure if it is possible in all cases.
>
> At least looking at C, there are company names too.
>
> I even saw a URL...

Hmm, I guess a checkpatch lint fits better then?

---
Cheers,
Benno

Re: [PATCH] rust: module: remove deprecated author key

[Miguel Ojeda]

On Tue, Jun 10, 2025 at 12:12 PM Benno Lossin <lossin@kernel.org> wrote:
>
> Hmm, I guess a checkpatch lint fits better then?

Yeah, that would work.

Probably for the C side too -- from a quick grep I don't see it.

Cheers,
Miguel

Re: [PATCH] rust: module: remove deprecated author key

[Guilherme Giacomo Simoes]

Miguel Ojeda <miguel.ojeda.sandonis@gmail.com> wrotes:
> On Tue, Jun 10, 2025 at 12:12 PM Benno Lossin <lossin@kernel.org> wrote:
> >
> > Hmm, I guess a checkpatch lint fits better then?
> 
> Yeah, that would work.
> 
> Probably for the C side too -- from a quick grep I don't see it.
Maybe, after this patch we can make a checkpatch change for check the `authors`
key (and MODULE_AUTHOR for C side), and throw a WARN if the author is a name
(not a url, or "rust for linux") and don't have a email address. 

Unless you guys tell me otherwise, I guess this is not so priority.

Thanks,
Guilherme

Re: [PATCH] rust: module: remove deprecated author key

[Miguel Ojeda]

On Tue, Jun 10, 2025 at 2:37 PM Guilherme Giacomo Simoes
<trintaeoitogc@gmail.com> wrote:
>
> Maybe, after this patch we can make a checkpatch change for check the `authors`
> key (and MODULE_AUTHOR for C side), and throw a WARN if the author is a name
> (not a url, or "rust for linux") and don't have a email address.
>
> Unless you guys tell me otherwise, I guess this is not so priority.

It is not a priority, and even if it were, it would be an independent
change, i.e. not for this patch series, so no worries :)

Cheers,
Miguel

Re: [PATCH] rust: module: remove deprecated author key

[Benno Lossin]

On Tue Jun 10, 2025 at 2:37 PM CEST, Guilherme Giacomo Simoes wrote:
> Miguel Ojeda <miguel.ojeda.sandonis@gmail.com> wrotes:
>> On Tue, Jun 10, 2025 at 12:12 PM Benno Lossin <lossin@kernel.org> wrote:
>> >
>> > Hmm, I guess a checkpatch lint fits better then?
>> 
>> Yeah, that would work.
>> 
>> Probably for the C side too -- from a quick grep I don't see it.
> Maybe, after this patch we can make a checkpatch change for check the `authors`
> key (and MODULE_AUTHOR for C side), and throw a WARN if the author is a name
> (not a url, or "rust for linux") and don't have a email address. 

Most other authors fields that don't list explicit names use "Rust for
Linux Contributors", so we should probably scan for that instead.

But I think that we should no longer add any author fields using that.
Things with that are from way back in the day (when RfL was still out of
tree) where many people contributed to a single file, hence the use of
that phrase.

> Unless you guys tell me otherwise, I guess this is not so priority.

Yeah this isn't high priority. We can just make this into a
good-first-issue, then someone can eventually pick it up.

---
Cheers,
Benno

Re: [PATCH] rust: module: remove deprecated author key

[Miguel Ojeda]

On Mon, Jun 9, 2025 at 2:22 PM Guilherme Giacomo Simoes
<trintaeoitogc@gmail.com> wrote:
>
> Commit 38559da6afb2 ("rust: module: introduce `authors` key") introduced
> a new `authors` key to support multiple module authors, while keeping
> the old `author` key for backward compatibility.
>
> Now that all in-tree modules have migrated to `authors`, remove:
> 1. The deprecated `author` key support from the module macro
> 2. Legacy `author` entries from remaining modules
>
> Signed-off-by: Guilherme Giacomo Simoes <trintaeoitogc@gmail.com>

Applied to `rust-next` -- thanks everyone!

    [ Reworded slightly. - Miguel ]

I don't see any new/missing ones in -next, so this should be clean. Let's see...

Cheers,
Miguel