author field in module! macro should be a array
Subsystems (13)
v5 cover author field in module! macro should be a array
In the module! macro, the author field is currently of type String. Since modules can have multiple authors, this limitation prevents specifying more than one.
- Change the author field to Option<Vec<String>> to allow creating modules with multiple authors.
- rename the field from author to authors to make it explicit that it can refer to multiple authors.
- In modules that use the author field, update its value to an array of strings, and also rename it from author to authors.
- Change the checkpatch.pl to find poorly formatted arrays in the macro module!
---
V5 changes
- Improved the checkpatch commit
- Improved the comment in checkpatch
- Removed uneccessary "\s*.*" in regex
- Aligned the WARN message
---
Guilherme Giacomo Simoes (2):
rust: module: change author to an array
checkpatch: throw error for malformed arrays
drivers/block/rnull.rs | 2 +- drivers/net/phy/ax88796b_rust.rs | 2 +- drivers/net/phy/qt2025.rs | 2 +- rust/kernel/net/phy.rs | 4 +-- rust/kernel/pci.rs | 2 +- rust/kernel/platform.rs | 2 +- rust/macros/lib.rs | 6 ++-- rust/macros/module.rs | 12 ++++---- samples/rust/rust_driver_faux.rs | 2 +- samples/rust/rust_driver_pci.rs | 2 +- samples/rust/rust_driver_platform.rs | 2 +- samples/rust/rust_minimal.rs | 2 +- samples/rust/rust_misc_device.rs | 2 +- samples/rust/rust_print_main.rs | 2 +- scripts/checkpatch.pl | 43 ++++++++++++++++++++++++++++ 15 files changed, 66 insertions(+), 21 deletions(-)
Signature · 1 line
2.34.1
PATCH v5 1/2 rust: module: change author to an array
In the module! macro, the author field is currently of type String. Since modules can have multiple authors, this limitation prevents specifying more than one.
Change the author field to Option<Vec<String>> to allow creating modules with multiple authors. Additionally, rename the field from author to authors to make it explicit that it can refer to multiple authors. In modules that use the author field, update its value to an array of strings, and also rename it from author to authors.
--- drivers/block/rnull.rs | 2 +- drivers/net/phy/ax88796b_rust.rs | 2 +- drivers/net/phy/qt2025.rs | 2 +- rust/kernel/net/phy.rs | 4 ++-- rust/kernel/pci.rs | 2 +- rust/kernel/platform.rs | 2 +- rust/macros/lib.rs | 6 +++--- rust/macros/module.rs | 12 +++++++----- samples/rust/rust_driver_faux.rs | 2 +- samples/rust/rust_driver_pci.rs | 2 +- samples/rust/rust_driver_platform.rs | 2 +- samples/rust/rust_minimal.rs | 2 +- samples/rust/rust_misc_device.rs | 2 +- samples/rust/rust_print_main.rs | 2 +- 14 files changed, 23 insertions(+), 21 deletions(-)
drivers/block/rnull.rs +1 -1
@@ -27,7 +27,7 @@module! {type :NullBlkModule , name:"rnull_mod" , - author:"Andreas Hindborg" , + authors: ["Andreas Hindborg" ], description:"Rust implementation of the C null block driver" , license:"GPL v2" , }
drivers/net/phy/ax88796b_rust.rs +1 -1
@@ -19,7 +19,7 @@ DeviceId::new_with_driver::<PhyAX88796B>() ], name: "rust_asix_phy", - author: "FUJITA Tomonori <[email protected]>", + authors: ["FUJITA Tomonori <[email protected]>"], description: "Rust Asix PHYs driver", license: "GPL", }
drivers/net/phy/qt2025.rs +1 -1
@@ -26,7 +26,7 @@ phy::DeviceId::new_with_driver::<PhyQT2025>(), ], name: "qt2025_phy", - author: "FUJITA Tomonori <[email protected]>", + authors: ["FUJITA Tomonori <[email protected]>"], description: "AMCC QT2025 PHY driver", license: "GPL", firmware: ["qt2025-2.0.3.3.fw"],
rust/kernel/net/phy.rs +2 -2
@@ -790,7 +790,7 @@ const fn as_int(&self) -> u32 {/// DeviceId::new_with_driver::<PhySample>() /// ], /// name: "rust_sample_phy", -/// author: "Rust for Linux Contributors", +/// authors: ["Rust for Linux Contributors"], /// description: "Rust sample PHYs driver", /// license: "GPL", /// }
@@ -819,7 +819,7 @@ const fn as_int(&self) -> u32 {/// module! { /// type: Module, /// name: "rust_sample_phy", -/// author: "Rust for Linux Contributors", +/// authors: ["Rust for Linux Contributors"], /// description: "Rust sample PHYs driver", /// license: "GPL", /// }
rust/kernel/pci.rs +1 -1
@@ -103,7 +103,7 @@ extern "C" fn remove_callback(pdev: *mut bindings::pci_dev) {/// kernel::module_pci_driver! { /// type: MyDriver, /// name: "Module name", -/// author: "Author name", +/// authors: ["Author name"], /// description: "Description", /// license: "GPL v2", /// }
rust/kernel/platform.rs +1 -1
@@ -101,7 +101,7 @@ fn of_id_table() -> Option<of::IdTable<Self::IdInfo>> {/// kernel::module_platform_driver! { /// type: MyDriver, /// name: "Module name", -/// author: "Author name", +/// authors: ["Author name"], /// description: "Description", /// license: "GPL v2", /// }
rust/macros/lib.rs +3 -3
@@ -36,7 +36,7 @@/// module!{ /// type: MyModule, /// name: "my_kernel_module", -/// author: "Rust for Linux Contributors", +/// authors: ["Rust for Linux Contributors"], /// description: "My very own kernel module!", /// license: "GPL", /// alias: ["alternate_module_name"],
@@ -69,7 +69,7 @@/// module!{ /// type: MyDeviceDriverModule, /// name: "my_device_driver_module", -/// author: "Rust for Linux Contributors", +/// authors: ["Rust for Linux Contributors"], /// description: "My device driver requires firmware", /// license: "GPL", /// firmware: ["my_device_firmware1.bin", "my_device_firmware2.bin"],
@@ -88,7 +88,7 @@/// # Supported argument types /// - `type`: type which implements the [`Module`] trait (required). /// - `name`: ASCII string literal of the name of the kernel module (required). -/// - `author`: string literal of the author of the kernel module. +/// - `authors`: array of ASCII string literals of the authors 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.
rust/macros/module.rs +7 -5
@@ -94,7 +94,7 @@ struct ModuleInfo { type_: String, license: String, name: String, - author: Option<String>, + authors: Option<Vec<String>>, description: Option<String>, alias: Option<Vec<String>>, firmware: Option<Vec<String>>,
@@ -107,7 +107,7 @@ fn parse(it: &mut token_stream::IntoIter) -> Self {const EXPECTED_KEYS : &[&str ] = &["type" ,"name" , -"author" , +"authors" ,"description" ,"license" , "alias",
@@ -135,7 +135,7 @@ 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),"alias" => info.alias =Some (expect_string_array (it)),
@@ -183,8 +183,10 @@ pub(crate) fn module(ts: TokenStream) -> TokenStream {let info =ModuleInfo ::parse (&mut it);let mut modinfo =ModInfoBuilder ::new (info.name.as_ref ()); -if let Some (author) = info.author { - modinfo.emit ("author" , &author); +if let Some (authors) = info.authors { +for authorin authors { + modinfo.emit ("authors" , &author); + } }if let Some (description) = info.description { modinfo.emit ("description" , &description);
samples/rust/rust_driver_faux.rs +1 -1
@@ -7,7 +7,7 @@module! {type :SampleModule , name:"rust_faux_driver" , - author:"Lyude Paul" , + authors: ["Lyude Paul" ], description:"Rust faux device sample" , license:"GPL" , }
samples/rust/rust_driver_pci.rs +1 -1
@@ -104,7 +104,7 @@ fn drop(&mut self) { kernel::module_pci_driver! {type :SampleDriver , name:"rust_driver_pci" , - author:"Danilo Krummrich" , + authors: ["Danilo Krummrich" ], description:"Rust PCI driver" , license:"GPL v2" , }
samples/rust/rust_driver_platform.rs +1 -1
@@ -43,7 +43,7 @@ fn drop(&mut self) { kernel::module_platform_driver! {type :SampleDriver , name:"rust_driver_platform" , - author:"Danilo Krummrich" , + authors: ["Danilo Krummrich" ], description:"Rust Platform driver" , license:"GPL v2" , }
samples/rust/rust_minimal.rs +1 -1
@@ -7,7 +7,7 @@module! {type :RustMinimal , name:"rust_minimal" , - author:"Rust for Linux Contributors" , + authors: ["Rust for Linux Contributors" ], description:"Rust minimal sample" , license:"GPL" , }
samples/rust/rust_misc_device.rs +1 -1
@@ -116,7 +116,7 @@module! {type :RustMiscDeviceModule , name:"rust_misc_device" , - author:"Lee Jones" , + authors: ["Lee Jones" ], description:"Rust misc device sample" , license:"GPL" , }
samples/rust/rust_print_main.rs +1 -1
@@ -8,7 +8,7 @@module! {type :RustPrint , name:"rust_print" , - author:"Rust for Linux Contributors" , + authors: ["Rust for Linux Contributors" ], description:"Rust printing macros sample" , license:"GPL" , }
Signature · 1 line
2.34.1
PATCH v5 2/2 checkpatch: throw error for malformed arrays
In reply to Guilherme Giacomo SimoesImplement a check to ensure that the author, firmware, and alias fields of the module! macro are properly formatted.
* If the array contains more than one value, enforce vertical formatting.
* If the array contains only one value, it may be formatted on a single line
--- scripts/checkpatch.pl | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+)
scripts/checkpatch.pl +43 -0
@@ -2775,6 +2775,9 @@ sub process { $realcnt = 0; $linenr = 0; $fixlinenr = -1; + + my %array_parse_module; + foreach my $line (@lines) { $linenr++; $fixlinenr++;
@@ -3567,6 +3570,46 @@ sub process { # ignore non-hunk lines and lines being removed next if (!$hunk_line || $line =~ /^-/); +# check if the field is about author, firmware or alias from module! macro and find malformed arrays + my $inline = 0; + my $key = ""; + my $add_line = $line =~ /^\+/; + + if ($line =~ /\b(authors|alias|firmware)\s*:\s*\[/) { + $inline = 1; + $array_parse_module{$1} = 1; + } + + my @keys = keys %array_parse_module; + if (@keys) { + $key = $keys[0]; + } + + if ($add_line && $key) { + my $herevet = "$here\n" . cat_vet($rawline) . "\n"; + + my $counter = () = $line =~ /"/g; + my $more_than_one = $counter > 2; + if ($more_than_one) { + WARN("ARRAY_MODULE_MACRO", + "Prefer each array element on a separate line\n". $herevet); + } elsif ($inline && $line !~ /\]/ && $line !~ /,/ && $line =~ /"/) { + WARN("ARRAY_MODULE_MACRO", + "Prefer declare ] on the same line\n$herevet"); + } elsif (!$inline && $line =~ /\]/ && $line =~ /\"/) { + WARN("ARRAY_MODULE_MACRO", + "Prefer a new line after the last value and before ]\n" . $herevet); + } elsif ($inline && $line =~ /,/ && $line !~ /\]/) { + WARN("ARRAY_MODULE_MACRO", + "Prefer a new line after [\n$herevet"); + } + } + + #END OF ANALYZE FIELD + if ($line =~ /\]/) { + delete $array_parse_module{$key}; + } + #trailing whitespace if ($line =~ /^\+.*\015/) { my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Signature · 1 line
2.34.1
Joe Perches
maintainerRe: [PATCH V5 2/2] checkpatch: throw error for malformed arrays
Quoted 2 lines · Guilherme Giacomo Simoes
Implement a check to ensure that the author, firmware, and alias fields of the module! macro are properly formatted.
Poor email subject.
scripts/checkpatch.pl
Quoted 1 line
scripts/checkpatch.pl +0
-0
[]
Quoted 20 lines
scripts/checkpatch.pl +16
-0@@ -3567,6 +3570,46 @@ sub process { # ignore non-hunk lines and lines being removed next if (!$hunk_line || $line =~ /^-/); +# check if the field is about author, firmware or alias from module! macro and find malformed arrays + my $inline = 0; + my $key = ""; + my $add_line = $line =~ /^\+/; + + if ($line =~ /\b(authors|alias|firmware)\s*:\s*\[/) { + $inline = 1; + $array_parse_module{$1} = 1; + } + + my @keys = keys %array_parse_module; + if (@keys) { + $key = $keys[0]; + } + + if ($add_line && $key) {
scripts/checkpatch.pl sub process { · line 3598
Quoted 10 lines
scripts/checkpatch.pl +10
-0+ my $herevet = "$here\n" . cat_vet($rawline) . "\n"; + + my $counter = () = $line =~ /"/g; + my $more_than_one = $counter > 2; + if ($more_than_one) { + WARN("ARRAY_MODULE_MACRO", + "Prefer each array element on a separate line\n". $herevet); + } elsif ($inline && $line !~ /\]/ && $line !~ /,/ && $line =~ /"/) { + WARN("ARRAY_MODULE_MACRO", + "Prefer declare ] on the same line\n$herevet");
Convert all the messages. Use consistent style.
scripts/checkpatch.pl sub process { · line 3604
Quoted 6 lines
scripts/checkpatch.pl +6
-0+ } elsif (!$inline && $line =~ /\]/ && $line =~ /\"/) { + WARN("ARRAY_MODULE_MACRO", + "Prefer a new line after the last value and before ]\n" . $herevet); + } elsif ($inline && $line =~ /,/ && $line !~ /\]/) { + WARN("ARRAY_MODULE_MACRO", + "Prefer a new line after [\n$herevet");
twice.
Re: [PATCH V4 2/2] checkpatch: throw error for malformed arrays
Quoted 1 line · Joe Perches
Poor email subject.
Okay, I will improve this
Quoted 1 line
Convert all the messages. Use consistent style.
Yes, my bad. This was is disatention.
Sending a v5...
Thanks,
Guilherme