From nobody Sun Feb 8 04:12:19 2026 Received: from mail-pl1-f182.google.com (mail-pl1-f182.google.com [209.85.214.182]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 892882206A3; Fri, 7 Mar 2025 16:07:22 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.214.182 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1741363644; cv=none; b=klOs0Kk0t8vbh5Sb+uuPvwjqKl65OtH3/AZeKRIilNb/+VTSshRq02qiQmG6/orr2HO0RlR0IqMEXVr2cvPDZh5gaiF9q8fg+lEIwrVIIezgXlcYARiE3N5N4luFkaXNHPeUcjzhaC8T38IODaiwmccD02F7NAGDePo4oxFnC/4= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1741363644; c=relaxed/simple; bh=JyfmwxfkhDQWHiwgvjB+4jZD9oKTfxClcnB8sh3GvKI=; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References: MIME-Version; b=DX+/XemQiCMeLinoR3qgJdro3O3I8+2wSlG4t0THY8XllF7AzQqdabrT4KwOMpdkHFSpxXSn6eSydOVi5ccFR3kDPvEARx68us3Lv63wjdhyIUv00zWPQTJ1rw8Rw1HX0qokcJxElh1426xFmOaVgYnS3/yknFuYqCWEJo4Ht5Q= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=ACBDHObX; arc=none smtp.client-ip=209.85.214.182 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="ACBDHObX" Received: by mail-pl1-f182.google.com with SMTP id d9443c01a7336-22438c356c8so7221835ad.1; Fri, 07 Mar 2025 08:07:22 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1741363642; x=1741968442; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=5tE39xgV6/KwKFHWvHCsh8kdiR8Jp34269cQhzUG4M8=; b=ACBDHObXLlFSykVMnOSRy+4hauN/zJcaidv4+z5ZFUsYXRkdaJ3DV3oQDbpO85x5zf JiamVjZffnH54QWTQlHlYg8ALI5Fc/EPb5LMz22MFFlUBP1UxgkPKYf2xFaCCxx0FAfI MG7S3SrpudEDPl5WKJkijV2rv7ulwngFR9onatZ/v8LjEUpBHTgR/OhZ20etMZ6gZ0X/ JL4+I/xnGdVh6AGC+QbzPZCXwjKcJchMT9lAEI66Rgby6tePHsSAmMpPuh74JWxhiKBX dYF6gmqnM5SE07iJq9BWrwYz5lgbxwouHIGA3ewcVsU5YgqiZQqgYGXlEXzg5ZVffEdc sitg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1741363642; x=1741968442; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=5tE39xgV6/KwKFHWvHCsh8kdiR8Jp34269cQhzUG4M8=; b=MmP9YQYT/nR3fq1XKTfIUtryzg1SJe/SE4hHiVwiH/JX7DQ1AnLDlUbM/tgT0GiwUN dLfxI1G8NNGfsPL+XLG0ic9+br4Pe3LSowHQc1yBYuaPvDVC2BPFGz6ceIY9NyZJgJ+A dJVrM+HycbXMIVQohQJQPOLr3tP5mR6PQC/XdoLE2yi0pr9lRiw3KHMFBfFMNGyLNwtz +/Mk31xwZMcMkAb9EhKV4rYs+cObe8Px/OoKi1yWe4TVsYlS+JL2nwH87YgXzrGwExtK WGc8hbYoUPjtIJ2I2P9Szh/kdDzbSk7+AZGtJtKv3YaaEGumD8cWELKYcrbAiDM8qQPI 60jg== X-Forwarded-Encrypted: i=1; AJvYcCUN5QKI4dnUdJePul+wkM16uoZ1/H5MDvY7WERjezBgHpaozzq/7/rlreab0Ifiv/2pnRqmMrTVzeVW72Y=@vger.kernel.org, AJvYcCV/LbYRv/ikz2HddCMI+acWPqfi8gh54iG6Cawr3rKEkudKruxb7gcSY1RzxkeWBdZp8lyNX71THyC8WoyFtws=@vger.kernel.org X-Gm-Message-State: AOJu0Yw41vuIT1REhTO/ptxhuX7s6XH1vNwz49EZ5Pu+och9/LA+5PKR b4Ok86/K+m4o6r2PE3hX9LySu1LYXYTzVjUva1FM2JzvhzaVt5m3 X-Gm-Gg: ASbGncuS9rxBxASGE5RXdIRoD+Wc5OX6wxwa60RuoUIbeJqo94LoL5w/E2oDzFsNYEU 2aBnwr5RualODqVHCb8sZ1RJP2MIu6WcSysdakMawmHof1OL0VhymSF3cuvpSy9WHU+D/H544X4 gpf2zRbG7dBaQVwEMYbeib48SZjSjW+foBTC8Ue3Tqpf9gXHutFnh2/PBGEZIWEbFYSZlQZSBWB R0LU00wdVspP+lCTboz0NvOo4sRNYGN603NQhYNcmKX+rs9dCoIBo4kCCVkpiCwdkPr1z2RJA3+ 1w9JytLuIjjM1EU5RbCi5+m9o/GQl7jFCQUuHNb6zNbt8hyZghco X-Google-Smtp-Source: AGHT+IF2UjHnis7PyMIFHMlbautNWH337h69jelFJAjycDlNWCUq4tFiXP0sbT0v8z6C7SEevqHEPQ== X-Received: by 2002:a05:6a00:4b4a:b0:736:339b:8296 with SMTP id d2e1a72fcca58-736aaabaedcmr6407409b3a.18.1741363641062; Fri, 07 Mar 2025 08:07:21 -0800 (PST) Received: from linuxsimoes.. ([187.120.156.44]) by smtp.gmail.com with ESMTPSA id d2e1a72fcca58-73698514f58sm3508421b3a.133.2025.03.07.08.07.14 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 07 Mar 2025 08:07:20 -0800 (PST) From: Guilherme Giacomo Simoes To: a.hindborg@kernel.org, alex.gaynor@gmail.com, aliceryhl@google.com, apw@canonical.com, arnd@arndb.de, aswinunni01@gmail.com, axboe@kernel.dk, benno.lossin@proton.me, bhelgaas@google.com, bjorn3_gh@protonmail.com, boqun.feng@gmail.com, dakr@kernel.org, dwaipayanray1@gmail.com, ethan.twardy@gmail.com, fujita.tomonori@gmail.com, gary@garyguo.net, gregkh@linuxfoundation.org, joe@perches.com, lukas.bulwahn@gmail.com, ojeda@kernel.org, pbonzini@redhat.com, tmgross@umich.edu, walmeida@microsoft.com, charmitro@posteo.net Cc: trintaeoitogc@gmail.com, rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org, Miguel Ojeda Subject: [PATCH V8 1/2] rust: module: change author to an array Date: Fri, 7 Mar 2025 13:06:56 -0300 Message-Id: <20250307160657.641014-2-trintaeoitogc@gmail.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20250307160657.641014-1-trintaeoitogc@gmail.com> References: <20250307160657.641014-1-trintaeoitogc@gmail.com> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" 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> 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. Suggested-by: Miguel Ojeda Link: https://github.com/Rust-for-Linux/linux/issues/244 Reviewed-by: Charalampos Mitrodimas Reviewed-by: Alice Ryhl Reviewed-by: Andreas Hindborg Signed-off-by: Guilherme Giacomo Simoes --- 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(-) diff --git a/drivers/block/rnull.rs b/drivers/block/rnull.rs index ddf3629d8894..d07e76ae2c13 100644 --- a/drivers/block/rnull.rs +++ b/drivers/block/rnull.rs @@ -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", } diff --git a/drivers/net/phy/ax88796b_rust.rs b/drivers/net/phy/ax88796b_ru= st.rs index 8c7eb009d9fc..bc73ebccc2aa 100644 --- a/drivers/net/phy/ax88796b_rust.rs +++ b/drivers/net/phy/ax88796b_rust.rs @@ -19,7 +19,7 @@ DeviceId::new_with_driver::() ], name: "rust_asix_phy", - author: "FUJITA Tomonori ", + authors: ["FUJITA Tomonori "], description: "Rust Asix PHYs driver", license: "GPL", } diff --git a/drivers/net/phy/qt2025.rs b/drivers/net/phy/qt2025.rs index 1ab065798175..520daeb42089 100644 --- a/drivers/net/phy/qt2025.rs +++ b/drivers/net/phy/qt2025.rs @@ -26,7 +26,7 @@ phy::DeviceId::new_with_driver::(), ], name: "qt2025_phy", - author: "FUJITA Tomonori ", + authors: ["FUJITA Tomonori "], description: "AMCC QT2025 PHY driver", license: "GPL", firmware: ["qt2025-2.0.3.3.fw"], diff --git a/rust/kernel/net/phy.rs b/rust/kernel/net/phy.rs index bb654a28dab3..a59469c785e3 100644 --- a/rust/kernel/net/phy.rs +++ b/rust/kernel/net/phy.rs @@ -790,7 +790,7 @@ const fn as_int(&self) -> u32 { /// DeviceId::new_with_driver::() /// ], /// 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", /// } diff --git a/rust/kernel/pci.rs b/rust/kernel/pci.rs index 4c98b5b9aa1e..f7b2743828ae 100644 --- a/rust/kernel/pci.rs +++ b/rust/kernel/pci.rs @@ -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", /// } diff --git a/rust/kernel/platform.rs b/rust/kernel/platform.rs index 50e6b0421813..1297f5292ba9 100644 --- a/rust/kernel/platform.rs +++ b/rust/kernel/platform.rs @@ -101,7 +101,7 @@ fn of_id_table() -> Option> { /// kernel::module_platform_driver! { /// type: MyDriver, /// name: "Module name", -/// author: "Author name", +/// authors: ["Author name"], /// description: "Description", /// license: "GPL v2", /// } diff --git a/rust/macros/lib.rs b/rust/macros/lib.rs index d61bc6a56425..7ce1cb891dfb 100644 --- a/rust/macros/lib.rs +++ b/rust/macros/lib.rs @@ -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 (req= uired). -/// - `author`: string literal of the author of the kernel module. +/// - `authors`: array of ASCII string literals of the authors of the ke= rnel module. /// - `description`: string literal of the description of the kernel mod= ule. /// - `license`: ASCII string literal of the license of the kernel modul= e (required). /// - `alias`: array of ASCII string literals of the alias names of the = kernel module. diff --git a/rust/macros/module.rs b/rust/macros/module.rs index cdf94f4982df..db16f0af0855 100644 --- a/rust/macros/module.rs +++ b/rust/macros/module.rs @@ -94,7 +94,7 @@ struct ModuleInfo { type_: String, license: String, name: String, - author: Option, + authors: Option>, description: Option, alias: Option>, firmware: Option>, @@ -107,7 +107,7 @@ fn parse(it: &mut token_stream::IntoIter) -> Self { const EXPECTED_KEYS: &[&str] =3D &[ "type", "name", - "author", + "authors", "description", "license", "alias", @@ -135,7 +135,7 @@ fn parse(it: &mut token_stream::IntoIter) -> Self { match key.as_str() { "type" =3D> info.type_ =3D expect_ident(it), "name" =3D> info.name =3D expect_string_ascii(it), - "author" =3D> info.author =3D Some(expect_string(it)), + "authors" =3D> info.authors =3D Some(expect_string_array(i= t)), "description" =3D> info.description =3D Some(expect_string= (it)), "license" =3D> info.license =3D expect_string_ascii(it), "alias" =3D> info.alias =3D Some(expect_string_array(it)), @@ -183,8 +183,10 @@ pub(crate) fn module(ts: TokenStream) -> TokenStream { let info =3D ModuleInfo::parse(&mut it); =20 let mut modinfo =3D ModInfoBuilder::new(info.name.as_ref()); - if let Some(author) =3D info.author { - modinfo.emit("author", &author); + if let Some(authors) =3D info.authors { + for author in authors { + modinfo.emit("authors", &author); + } } if let Some(description) =3D info.description { modinfo.emit("description", &description); diff --git a/samples/rust/rust_driver_faux.rs b/samples/rust/rust_driver_fa= ux.rs index 048c6cb98b29..378bab4b587d 100644 --- a/samples/rust/rust_driver_faux.rs +++ b/samples/rust/rust_driver_faux.rs @@ -7,7 +7,7 @@ module! { type: SampleModule, name: "rust_faux_driver", - author: "Lyude Paul", + authors: ["Lyude Paul"], description: "Rust faux device sample", license: "GPL", } diff --git a/samples/rust/rust_driver_pci.rs b/samples/rust/rust_driver_pci= .rs index 1fb6e44f3395..364a0660a743 100644 --- a/samples/rust/rust_driver_pci.rs +++ b/samples/rust/rust_driver_pci.rs @@ -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", } diff --git a/samples/rust/rust_driver_platform.rs b/samples/rust/rust_drive= r_platform.rs index 8120609e2940..f7a0f1b29d1d 100644 --- a/samples/rust/rust_driver_platform.rs +++ b/samples/rust/rust_driver_platform.rs @@ -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", } diff --git a/samples/rust/rust_minimal.rs b/samples/rust/rust_minimal.rs index 4aaf117bf8e3..1fc7a1be6b6d 100644 --- a/samples/rust/rust_minimal.rs +++ b/samples/rust/rust_minimal.rs @@ -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", } diff --git a/samples/rust/rust_misc_device.rs b/samples/rust/rust_misc_devi= ce.rs index 40ad7266c225..d3785e7c0330 100644 --- a/samples/rust/rust_misc_device.rs +++ b/samples/rust/rust_misc_device.rs @@ -116,7 +116,7 @@ module! { type: RustMiscDeviceModule, name: "rust_misc_device", - author: "Lee Jones", + authors: ["Lee Jones"], description: "Rust misc device sample", license: "GPL", } diff --git a/samples/rust/rust_print_main.rs b/samples/rust/rust_print_main= .rs index 7e8af5f176a3..8ea95e8c2f36 100644 --- a/samples/rust/rust_print_main.rs +++ b/samples/rust/rust_print_main.rs @@ -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", } --=20 2.34.1 From nobody Sun Feb 8 04:12:19 2026 Received: from mail-pj1-f52.google.com (mail-pj1-f52.google.com [209.85.216.52]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 99F1F224AF1; Fri, 7 Mar 2025 16:07:29 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.216.52 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1741363651; cv=none; b=UW26wBHqRiHtgvqa2Vn6kzCxgPkuqxUg/fHRELyfNWmCruXzlgn+C7Knwo7pJsDyNhpZTSifqnLeddO1M0sw8kFuTMKwkidqDEE30gIVuOLNt1k2ftfMSywNFe980NMyhfu/7lw3l1s2I37nyP2G1eoxWRViKqO3BJrlRiXbdFI= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1741363651; c=relaxed/simple; bh=hA+AL+YkmFHDqEOTVvDJnon/Dsjcg3uYfNOntsX5TuY=; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References: MIME-Version; b=CehwgzWxSJM4lwnTk/ZTCtXKC3/TiXh8UVwBLKKFQy7QI7NBP07zNeuACSki8NDDY0eHpzFP3DSPFnhRj0kox/4bORyVqBldHMLCNPiHYPV7ytZQejg5yjcwxBx7PFNSqX+vir+C7G1vNu4acQrv4JFVzRNouTEnuQYOpz87DMI= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=bXX0Xh++; arc=none smtp.client-ip=209.85.216.52 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="bXX0Xh++" Received: by mail-pj1-f52.google.com with SMTP id 98e67ed59e1d1-2feb91a25bdso3310081a91.1; Fri, 07 Mar 2025 08:07:29 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1741363649; x=1741968449; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=muSHbuLdeyMAAgXAmJf/8jxjECvkvJugZR3BtpEzTko=; b=bXX0Xh++fqkCwZJ9fjvstyd6bJXUegSTtug6Rzuz3QrXMHRW6lRrzB9iydX05qP0Ka SErcdbXmBcWnxJF8uOmkSEUjpIIfWHsjeJaQ+tf8v2PAKg8MJqQ1Tts5m2XsH6fzBGy8 Y4O49+ChZkOoG3m2MH/k2g+z6uIi7yTrCrQ5LCkvZ5AVMLIGXVN1kjmMnVQl++Xs9S6x EhAIjTnBBrsK05/cFzxeNwQ0j9Kax+pTGdEatILPDncyvD4Xz3IxG0MRESgQuyvG+1mg 3MvJ3K0tUhNhtrI1zwSfPV6SC50LqgZxQYqgFRAD2zPxzcnCpeUBmVEQgj7Xy+nirfc9 AsVQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1741363649; x=1741968449; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=muSHbuLdeyMAAgXAmJf/8jxjECvkvJugZR3BtpEzTko=; b=vWvro7J2OAi2jwfvpfMoh/EHmrc6eOMVv9GNOdRgdbDcr78KLI2zF1D9xbelfAgfKa wqatOdI504MtuQACEYakaDJURo1NWORswPR1ltszT7uBM69lrdJYtSao0mMuszr7DOxi oNg4e2B8Anj874MaiY6XouE32ADOPBwnp9uv0WzDSkjmWqQh2Hk4f8tE5zr8NpFNHjpq B5OmVsdqxMj6vcY26FjSwbUhqgSP4+DXuIywOX3cx0sCGrqRhcdsYwDGPllumvNTxFoe ElVivz8pQ1o/0qv/gL6X4aEYAwqAYeqMIyGiKO67fIvTEpESgDvOshmuMC8CumufImx4 rAbA== X-Forwarded-Encrypted: i=1; AJvYcCWfTbqoZ0WsLwlkBlCskgTFS0/CuiwWfw8SL598u28KBll3/WjBhrQ2sXTwcj0r0ZOB66Ylgu6VMMETxYYWHsU=@vger.kernel.org, AJvYcCX/f4bSWjTKtOBjR7bcBYgnIZmbZMMEBZskaUXjetmSOPCHiG22ZF5Db788KyA2Wyr0QIAfiEtsMSrugMI=@vger.kernel.org X-Gm-Message-State: AOJu0Yws/T/hcoD1Me37abPYMxuLrNuqaxyeUkqEhVNhU8rfx2yWZP0F 34y5lGBBkxbM1qzmJWLPgJ/EzYwV4SGmWSi+4A/MTFHXfRDjmy00 X-Gm-Gg: ASbGncvJNQi8S1ITyRV5nTO7Educ2+ONqMA6Uv7Rv1JLXXReBXYCuA7UzNpYXSzQKxH Desz0x+HHzM3m1rgS5TYLZ+McS9vQzr8lmr5gGlLNpk5FkNQBkus3P3l3xN6em3/f8uPXfunmTG xjoGkW1tuLvX4kz9JoS7ADl0EhQVk2jVZUvt1Ess05PpJ0IoJYZ66iSp/cTrej9QPXPRCbH5MIo nz9K+SkWKqdL68kYbiLj1/0uK7m5WpC4Z6PGPaaA0Qx3g6/senjM7gSlok0JbrmBh58W9pPBB2E ZU9c6vLmADlAwskv8z4RfCkTLCa4k/RPe0XasjTfBbp2ub+fZiz4 X-Google-Smtp-Source: AGHT+IGbVVmSwsbZ/9unYd5P33Ov3VnOcA7398ApJfdmkFjWzqlBhHbHlXRQjTiV7Gl20J/wA/FuEg== X-Received: by 2002:a05:6a21:2d08:b0:1ee:dcd3:80d7 with SMTP id adf61e73a8af0-1f54493353emr7708311637.0.1741363648889; Fri, 07 Mar 2025 08:07:28 -0800 (PST) Received: from linuxsimoes.. ([187.120.156.44]) by smtp.gmail.com with ESMTPSA id d2e1a72fcca58-73698514f58sm3508421b3a.133.2025.03.07.08.07.22 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 07 Mar 2025 08:07:28 -0800 (PST) From: Guilherme Giacomo Simoes To: a.hindborg@kernel.org, alex.gaynor@gmail.com, aliceryhl@google.com, apw@canonical.com, arnd@arndb.de, aswinunni01@gmail.com, axboe@kernel.dk, benno.lossin@proton.me, bhelgaas@google.com, bjorn3_gh@protonmail.com, boqun.feng@gmail.com, dakr@kernel.org, dwaipayanray1@gmail.com, ethan.twardy@gmail.com, fujita.tomonori@gmail.com, gary@garyguo.net, gregkh@linuxfoundation.org, joe@perches.com, lukas.bulwahn@gmail.com, ojeda@kernel.org, pbonzini@redhat.com, tmgross@umich.edu, walmeida@microsoft.com, charmitro@posteo.net Cc: trintaeoitogc@gmail.com, rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH V8 2/2] checkpatch: check format of Vec in modules Date: Fri, 7 Mar 2025 13:06:57 -0300 Message-Id: <20250307160657.641014-3-trintaeoitogc@gmail.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20250307160657.641014-1-trintaeoitogc@gmail.com> References: <20250307160657.641014-1-trintaeoitogc@gmail.com> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" Implement 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 Signed-off-by: Guilherme Giacomo Simoes --- scripts/checkpatch.pl | 67 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 67 insertions(+) diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl index 7b28ad331742..7c42c1a0ea6b 100755 --- a/scripts/checkpatch.pl +++ b/scripts/checkpatch.pl @@ -2775,6 +2775,12 @@ sub process { $realcnt =3D 0; $linenr =3D 0; $fixlinenr =3D -1; + + my %array_parse_module; + my $expected_spaces; + my $spaces; + my $herevet_space_add; + foreach my $line (@lines) { $linenr++; $fixlinenr++; @@ -3567,6 +3573,67 @@ sub process { # ignore non-hunk lines and lines being removed next if (!$hunk_line || $line =3D~ /^-/); =20 +# check if the field is about author, firmware or alias from module! macro= and find malformed arrays + my $inline =3D 0; + my $key =3D ""; + my $add_line =3D $line =3D~ /^\+/; + + if ($line =3D~ /\b(authors|alias|firmware)\s*:\s*\[/) { + $inline =3D 1; + $array_parse_module{$1} =3D 1; + } + + my @keys =3D keys %array_parse_module; + if (@keys) { + $key =3D $keys[0]; + } + + if (!$expected_spaces && (!$add_line && $key && !$inline)) { + if ($line =3D~ /^([\t ]+)(\s)/) { + $expected_spaces =3D $1; + } + } + + if ($add_line && $key) { + my $herevet =3D "$here\n" . cat_vet($rawline) . "\n"; + + my $counter =3D () =3D $line =3D~ /"/g; + my $more_than_one =3D $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 =3D~ /"/) { + WARN("ARRAY_MODULE_MACRO", + "Prefer declare ] on the same line\n" . $herevet); + } elsif (!$inline && $line =3D~ /\]/ && $line =3D~ /\"/) { + WARN("ARRAY_MODULE_MACRO", + "Prefer a new line after the last value and before ]\n" . $hereve= t); + } elsif ($inline && $line =3D~ /,/ && $line !~ /\]/) { + WARN("ARRAY_MODULE_MACRO", + "Prefer a new line after [\n" . $herevet); + } + + if ($line =3D~ /^\+\s*([\t ]+)(\S)/) { + $spaces =3D $1; + $herevet_space_add =3D $herevet; + } + } + + if ($expected_spaces && $spaces) { + if (length($spaces) !=3D length($expected_spaces)) { + WARN("ARRAY_MODULE_MACRO", + "Prefer a align parameters\n" . $herevet_space_add); + } + + $spaces =3D undef; + } + + #END OF ANALYZE FIELD + if ($line =3D~ /\]/) { + delete $array_parse_module{$key}; + $expected_spaces =3D undef; + } + #trailing whitespace if ($line =3D~ /^\+.*\015/) { my $herevet =3D "$here\n" . cat_vet($rawline) . "\n"; --=20 2.34.1