author field in module! macro should be a array
Subsystems (9)
v3 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!
---
V3 changes
- Improved commit messages
- Changed field name from author to authors
- Included the forgeted samples/rust/rust_driver_platform.rs in 1/2
- Change the documentation in rnull.rs
- Fixing the WARNING messages in checkpatch
- Fixing align messages in checkpatch
- Removed unneccessary \n in $herevet in checkpatch
---
Guilherme Giacomo Simoes (2):
rust: module: change author to an array
checkpatch: throw error for malformed arrays
drivers/block/rnull.rs | 2 +- rust/kernel/net/phy.rs | 4 +-- rust/kernel/pci.rs | 2 +- rust/macros/lib.rs | 6 ++-- rust/macros/module.rs | 12 ++++---- 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 ++++++++++++++++++++++++++++ 11 files changed, 62 insertions(+), 17 deletions(-)
Signature · 1 line
2.34.1
PATCH v3 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 +- rust/kernel/net/phy.rs | 4 ++-- rust/kernel/pci.rs | 2 +- rust/macros/lib.rs | 6 +++--- rust/macros/module.rs | 12 +++++++----- 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 +- 10 files changed, 19 insertions(+), 17 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" , }
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/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_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 v3 2/2 checkpatch: throw error for malformed arrays
In reply to Guilherme Giacomo SimoesImplement a check to ensure these fields are correctly formatted. If a line contains one of these keys that should be of type Vec<String>, use a regex to verify whether the array holds multiple values.
* If the array contains more than one value, enforce vertical formatting
* If the array has only one value, it can remain on the same 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 arrays has more than one value in the same line + my $inline = 0; + my $key = ""; + my $add_line = $line =~ /^\+/; + + if ($line =~ /\s*.*\b(author|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 a single-line value$herevet"); + } elsif ($inline && $line !~ /\]/ && $line !~ /,/ && $line =~ /"/) { + WARN("ARRAY_MODULE_MACRO", + "Prefer declare ] on the same line$herevet"); + } elsif (!$inline && $line =~ /\]/ && $line =~ /\"/) { + WARN("ARRAY_MODULE_MACRO", + "Prefer a new line after the last value and before ]$herevet"); + } elsif ($inline && $line =~ /,/ && $line !~ /\]/) { + WARN("ARRAY_MODULE_MACRO", + "Prefer a new line after [$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
Re: [PATCH V3 2/2] checkpatch: throw error for malformed arrays
Quoted 26 lines · Guilherme Giacomo Simoes
Implement a check to ensure these fields are correctly formatted. If a line contains one of these keys that should be of type Vec<String>, use a regex to verify whether the array holds multiple values.
* If the array contains more than one value, enforce vertical formatting
* If the array has only one value, it can remain on the same lineSigned-off-by Guilherme Giacomo Simoes <[email protected]>--- scripts/checkpatch.pl | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+)scripts/checkpatch.pl +3
-0@@ -2775,6 +2775,9 @@ sub process { $realcnt = 0; $linenr = 0; $fixlinenr = -1; + + my %array_parse_module; + foreach my $line (@lines) { $linenr++; $fixlinenr++;
scripts/checkpatch.pl sub process { · line 3578
Quoted 9 lines
scripts/checkpatch.pl +6
-0@@ -3567,6 +3570,46 @@ sub process { # ignore non-hunk lines and lines being removed next if (!$hunk_line || $line =~ /^-/); +# check if arrays has more than one value in the same line + my $inline = 0; + my $key = ""; + my $add_line = $line =~ /^\+/; + + if ($line =~ /\s*.*\b(author|alias|firmware)\s*:\s*\[/) {
Hi Guilherme,
Will this work now that the field is called "authors" and not "author"? I think you forgot to update the regex here.
Quoted 7 lines
scripts/checkpatch.pl +7
-0+ $inline = 1; + $array_parse_module{$1} = 1; + } + + my @keys = keys %array_parse_module; + if (@keys) { + $key = $keys[0];
scripts/checkpatch.pl sub process { · line 3595
Quoted 10 lines
scripts/checkpatch.pl +10
-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 a single-line value$herevet");
What do you think about this instead?
"Prefer each array element on a separate line$herevet"
Quoted 20 lines
scripts/checkpatch.pl +17
-0+ } elsif ($inline && $line !~ /\]/ && $line !~ /,/ && $line =~ /"/) { + WARN("ARRAY_MODULE_MACRO", + "Prefer declare ] on the same line$herevet"); + } elsif (!$inline && $line =~ /\]/ && $line =~ /\"/) { + WARN("ARRAY_MODULE_MACRO", + "Prefer a new line after the last value and before ]$herevet"); + } elsif ($inline && $line =~ /,/ && $line !~ /\]/) { + WARN("ARRAY_MODULE_MACRO", + "Prefer a new line after [$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";
Re: [PATCH V3 2/2] checkpatch: throw error for malformed arrays
Quoted 4 lines · Charalampos Mitrodimas
Hi Guilherme,
Will this work now that the field is called "authors" and not "author"? I think you forgot to update the regex here.
I don't know, I make change in modules and samples, and I forget runing again the checkpatch.
Sorry ..
I will send a v4
Quoted 2 lines
What do you think about this instead?
"Prefer each array element on a separate line$herevet"
For me, looks like great
Thanks,
Guilherme
Re: [PATCH V3 2/2] checkpatch: throw error for malformed arrays
Quoted 9 lines · Guilherme Giacomo Simoes
Quoted 4 lines · Charalampos Mitrodimas
Hi Guilherme,
Will this work now that the field is called "authors" and not "author"? I think you forgot to update the regex here.
I don't know, I make change in modules and samples, and I forget runing again the checkpatch.
Sorry ..
I will send a v4
Keep in mind that now we also have the faux device sample upstream, which uses the old single-author module field. Please build against the latest tree and include the fix for that driver.
It can be found under the path "samples/rust/rust_driver_faux.rs".
Quoted 7 lines
Quoted 3 lines
What do you think about this instead?
"Prefer each array element on a separate line$herevet"For me, looks like great
Thanks,
Guilherme