From nobody Thu Dec 18 08:36:03 2025 Received: from mail-pj1-f53.google.com (mail-pj1-f53.google.com [209.85.216.53]) (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 8E42E81727; Sun, 23 Feb 2025 17:42:30 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.216.53 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1740332552; cv=none; b=oRVqTw5zx0o+1PRtSwHKVqLvWqLHzOzky5/Y2zbA/Bc48BVIdrWrrMTwUzVocMCvyP868AFSNJoAxfX49ROGCRkij/o4Rl/C6dzibB8JI6RZ4hXjqqPNwq7j/8PxqXq0aPXqyYu8JmLzeyCubQnlu6XCOcXVOl8waMpSUjBaHnU= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1740332552; c=relaxed/simple; bh=NvsboGZDQg2K6gbDOlFfp6AG8Dc0DEPLS28koKynLpw=; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References: MIME-Version; b=t31948mxXaaA0fVBiqlEE6WBxIyssNH5jskEQbINbFvP/grDVGSIHbke2/rIFc8SwaKMPoTyt8b/vMajxv3UlnVVa32lqruMq6wRUCIDWjD0lzIFSrY8RGdPUP+8z9B8qUU4GM90Sp8hbwMHghnGzyy4a7JaN4tOSjNh4qVbayI= 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=O+n5EXZs; arc=none smtp.client-ip=209.85.216.53 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="O+n5EXZs" Received: by mail-pj1-f53.google.com with SMTP id 98e67ed59e1d1-2fbf77b2b64so7532572a91.2; Sun, 23 Feb 2025 09:42:30 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1740332550; x=1740937350; 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=rPK9X6DcPZjak+3FAEnmi0RwUkfaASpRjIZbmzsOugI=; b=O+n5EXZs9QKp1Ly/p3mo0dHhiCUrJPI0aQLNeHFhKkqVQQLWKeA8g4/9j06h5Z5aSe KixdjukUx3JKNrvUe5g9dqLRAxhoONssFdOTj7KwYXVZTwlwghI19RSBD8QbKMwDWflK Wu9/xH6+0+PNO4eDtN+NiXUGc5y/UDCmHs/u5mIgdmQu55VbvUDFRn8B6wvxZaX/FAnE Cvb+XNJTaNJIAf1o8f7XNx5zdnvk//0EysDSzcOhWOMU5EjsSvSLBei1wUYZtr3IWRDT +rtHxnHahMkZC67YzOj7Hlf9XHImvHEKxdxIIBSERkKi8sx6l1AuMfBO+cyJSNBxdrnP kNww== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1740332550; x=1740937350; 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=rPK9X6DcPZjak+3FAEnmi0RwUkfaASpRjIZbmzsOugI=; b=SDvHBzYl16lsXH5NEF3lDT19ezKRkOjQr3ZY84EaubGB/bFg5mkBdEk6sSIECNvUul dgj54fhVIOAAXfxra+7vzhRF2IiqyKOMA9mJsd0BzmFtp+LwKd+WeetXTFGm0J+4Oead tjVrIKkp9qnCecTujAghKjMwZbbu8cVZ6Bw5GHR6/+2AcinrhV6gn3tXukN1FHz7B75e 1Z3BxhnD44CG0ds9f9z5g0CQYwozIg4VD0SO2nZYEfaMnH/ki/Cws7DUdp1ldKeFzj57 c2bdxgAEBLth/lYyOxTPma0++5mrECJce0Bd4ivQHNb175EsX9//J/iuFXGdgYvn5YvJ H2hw== X-Forwarded-Encrypted: i=1; AJvYcCUYptO0J2NSOpdZlMganJgpSvQCqfqCQCnXgeFZFCaKOWhMbwX01753g3lFKFL38GBRywG2vT+y1pbcrSlMJi8=@vger.kernel.org, AJvYcCXXZ1TV7rcEBcoJdi7dceOKKpvxa8UpBTo9lOztB26vPTnrqYS5Gi3HZg4okt0DGs7lMCIhGnysIuJpEao=@vger.kernel.org X-Gm-Message-State: AOJu0YwAR6XxjT+kBg5rgIXa5YgdQceRAIXeu2XRL3lHMHgLZ3etnz08 BHr23rAAHi/JQRYxOTVR86jd1cHVz3RaQh7A8Z95MzaZgUiU47aJ X-Gm-Gg: ASbGncvvZxtAokz3l+TdE4xm2ru18sE+pzX0al7k92eNvm2t7NtuBrBxAKq+nldCc7d hNbZWCGOBajsFM4PrC9qr9IJnlix8q3QuXoeY4q8CX7GL8t2VNTvwTlmrZ1pDqoNGtTRdCOKzIg ehsmyDmXWf2js1y3oyDgl0E+Bskc2DGyr7TQDGmSXiHwvv7PsxNTr40zSHJ7ysct622okjwxlwM osYTBfd7rOC00+SchdW57hPpBDoZvzvr+ghLo9eicmEbDp6/a6Diftcdd8NlX7mYDXpncm7O1Qa snH1Y5qxrIWUA7Uf5DWY6LyxkfhGoMQjwQ== X-Google-Smtp-Source: AGHT+IHaIjLjXrMy3VJemKxbmP5jakK+SXN/0/GHcDeAnx7szWlGktubT7pG/EYr6NR7up134aoUbA== X-Received: by 2002:a05:6a21:9015:b0:1f0:e90b:fdf3 with SMTP id adf61e73a8af0-1f0e90bfeb7mr2115759637.31.1740332549656; Sun, 23 Feb 2025 09:42:29 -0800 (PST) Received: from linuxsimoes.. ([177.21.141.136]) by smtp.gmail.com with ESMTPSA id 41be03b00d2f7-adb5aa21bbfsm17433834a12.74.2025.02.23.09.42.21 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 23 Feb 2025 09:42:29 -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 Cc: trintaeoitogc@gmail.com, rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org, Miguel Ojeda Subject: [PATCH V6 1/2] rust: module: change author to an array Date: Sun, 23 Feb 2025 14:42:04 -0300 Message-Id: <20250223174205.48404-2-trintaeoitogc@gmail.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20250223174205.48404-1-trintaeoitogc@gmail.com> References: <20250223174205.48404-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 Signed-off-by: Guilherme Giacomo Simoes Reviewed-by: Alice Ryhl Reviewed-by: Andreas Hindborg Reviewed-by: Charalampos Mitrodimas --- 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 Thu Dec 18 08:36:03 2025 Received: from mail-pj1-f46.google.com (mail-pj1-f46.google.com [209.85.216.46]) (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 2BD07158558; Sun, 23 Feb 2025 17:42:38 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.216.46 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1740332560; cv=none; b=H1Lsqrj9Sp2MqvTCHhijBVzTnOp1AaJkGhA/vDNQFdQF7mSj5KgaKP3K+/wHo6DdtcIUgkGhRG8Vs+vp7P14y7OBs+ZuckRMbuDQOnB1HxUODNXA6ulfua8W0N7KJnBBaM/yInZVwgygczWaL+uUgCLW2+XLAf5SrcI9YiXupMo= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1740332560; c=relaxed/simple; bh=Z9EHzj/9TMsdRybcSGrBxIUApr0DZUACq6j0urRmUsI=; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References: MIME-Version; b=c8n0xGKRPP8MTgE2ZOoBm1aHoKOB5en2Z/V1deuQydnN5SYL43DnE4xy+L6Fx5NCLUKfgOdp6ifp1pwBXllt1niI86oX6tHt2ielitdjIK16hu8OyxmvB84OnLlbmRMYqgKj6glzfGaLkMT+1Qd8fAE9VYNHjjeXY+LhZyA365c= 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=HTNKRxuF; arc=none smtp.client-ip=209.85.216.46 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="HTNKRxuF" Received: by mail-pj1-f46.google.com with SMTP id 98e67ed59e1d1-2fcb6c42c47so5693450a91.1; Sun, 23 Feb 2025 09:42:38 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1740332558; x=1740937358; 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=A+/OYTmylIIw4plgNkwf6eTBea+h42xj2aKz3F23uVE=; b=HTNKRxuFGVXCH9RPih7FnU9R/H/7CSE1NcztR7wsptyPWhAt0FDsuDvUXdhJdRBBH3 b9Dc6zI3tCBW2z9kZkSdg9t1dM+gPJwfFg65msFM3msM8ntNK5uE1T85FfXnSDQpWtvK JQeZglVg7cc0c1kCeHtiHqJLbZetWAX+s+w+LDWmvIxXgDQf8YyYsE74f9W5PfDN+FLG Mi5MaSwINNPe8vy38hyR0vwGnPZ2HeJJA0v+6ZphQi1hl1v/BCOnVrhw0SqwziFBebUr LH4ioYwcZ44us9jp1fFobmdk5p5w5KSrMwtAcpmhhOSj4/Zt04duK3XqLlzBNIXMIJfK cRbg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1740332558; x=1740937358; 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=A+/OYTmylIIw4plgNkwf6eTBea+h42xj2aKz3F23uVE=; b=AbInw6iqCgHWUORgAjUvitGsXynWq4HGLHwly6Be+nrvZHkYquWcSWe2B3uJP3PeLR ceskmiTNACUcIi6G65dB4kBfkrnZhVzoTZaZp7zTHx0FVsf/ICLpvanhqu43xh7RvCHy FLUkJPvi3EO6EaKDebZ5WUEULzi4pHAlcvDAGKvwLlL7vjt7B+uQmBzWohBP0ugmPhkI PzjMmRPbX+ZlSLgCwVAFxIKzZqG3KtjertIFIxqvU7okJl1mTKJ+0uXOU6Mk1Lrm7IX+ /4e+ekgeKEMlpVhb1CYNPleRNP3LwNWEBqcg6WFmkOfFElvyxk313/NsZq7lnWd6sYfa SZqQ== X-Forwarded-Encrypted: i=1; AJvYcCVEtm0okF8lPMV7Mp+S+bFOWeddkjT8ibIYZvz/GUQzsZrQQ5bEXPbW0uXI3mvLcsawb/gWXVfk7Mh1TivsJYQ=@vger.kernel.org, AJvYcCWhdcIsQq/KTxnwRVq+FFW6aPAnKwTtsviSYvgiidcE1rC2gx6+B5UtiXf1gWaqIZJeMA0doqT3fybcNI8=@vger.kernel.org X-Gm-Message-State: AOJu0Yw6CjsXitkycjbGwnDgP6bg6YvKE19YgHcEBDo/lZv2S7XhtZqm IPLTg/S2armU6nOEi4z7Fg6A7hxLfOU/kgiXrXd4q+jPAdA0vIvv X-Gm-Gg: ASbGncu2DcgwlpuPqP0VcYEAsuUHQn+8DJ1owGN9zuWrO+SNY/BEW0EInlayzglMlGK AMziKfRDQuUtHQc0/LQIxrvaa/L27HTT/pxcjwOzzo5E4tLHOJFpD2ewvTNiNK9NrMdJ6fR2426 Oj52rbXfjjguLoVRygLr9TYv6GDY4Vlqp+t2HQuQi1SezD5+z/vcNiWxuCz366PO9ZsqdfznG6s zBl8vT2sp8Tuaabn3+hZhGC2EIP2xCIO7bRbsUWGLKx6ST3TItoTle+rii1JuT/7wSL3akcOHTb i8T8lO1ZjfaJkPJzZUqb2xGcyQDrTu888Q== X-Google-Smtp-Source: AGHT+IE7wAeQ0OmTe+ASeV4iyklAhyLabEc7dmvwMoDTWTlzoTjT9dcAh0mXSC4no787TtfbCR7Fxw== X-Received: by 2002:a05:6a21:9218:b0:1ee:cb08:d0a8 with SMTP id adf61e73a8af0-1eef3cb91d7mr19610972637.21.1740332558209; Sun, 23 Feb 2025 09:42:38 -0800 (PST) Received: from linuxsimoes.. ([177.21.141.136]) by smtp.gmail.com with ESMTPSA id 41be03b00d2f7-adb5aa21bbfsm17433834a12.74.2025.02.23.09.42.30 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 23 Feb 2025 09:42:37 -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 Cc: trintaeoitogc@gmail.com, rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH V6 2/2] checkpatch: check format of Vec in modules Date: Sun, 23 Feb 2025 14:42:05 -0300 Message-Id: <20250223174205.48404-3-trintaeoitogc@gmail.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20250223174205.48404-1-trintaeoitogc@gmail.com> References: <20250223174205.48404-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 Tested-by: Andreas Hindborg --- scripts/checkpatch.pl | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl index 7b28ad331742..54e1893d13aa 100755 --- a/scripts/checkpatch.pl +++ b/scripts/checkpatch.pl @@ -2775,6 +2775,9 @@ sub process { $realcnt =3D 0; $linenr =3D 0; $fixlinenr =3D -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 =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 ($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); + } + } + + #END OF ANALYZE FIELD + if ($line =3D~ /\]/) { + delete $array_parse_module{$key}; + } + #trailing whitespace if ($line =3D~ /^\+.*\015/) { my $herevet =3D "$here\n" . cat_vet($rawline) . "\n"; --=20 2.34.1