From nobody Tue Dec 16 23:41:16 2025 Received: from smtp.kernel.org (aws-us-west-2-korg-mail-1.web.codeaurora.org [10.30.226.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id A57641DED76; Mon, 24 Mar 2025 21:04:15 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=10.30.226.201 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1742850255; cv=none; b=f8uvoNxoGmgrXSwuljQzZ9s1MSTw/1ZKdQxJ3yNv3g15QfuTY+zJ+1xVsSnbg8Ne9gl1gxj2sOwl6ItzQwhl2f+nyBWKV38clImIIXCCM+X/v4Yg3RekHqPOAx1Zx9ReijKslsqz3QIybAp+e0hS/GqPjRCEjoyG9qJBgYUi4Mc= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1742850255; c=relaxed/simple; bh=tUz2qusKTvBmkeN4ksXUVEfMZCjH960Ip+LLkF/SukA=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=IJdXiyZYCjyxgw0EqBVuwpHu59ZH14/oRHvM90TUOQcvORzbjTT+VtvVNyT3PwbgYe58yhEtbbNZaupkhbt/5qidoBqu5PNuogFdtEndjdyWgufNdUcjEnGRT05o9JHXDBveGQxQmmvOlHMuyj7r3HFnX6tZvffwlQF/ewFaIDs= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=fEBpWuZM; arc=none smtp.client-ip=10.30.226.201 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b="fEBpWuZM" Received: by smtp.kernel.org (Postfix) with ESMTPSA id 0DCE8C4CEDD; Mon, 24 Mar 2025 21:04:10 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1742850255; bh=tUz2qusKTvBmkeN4ksXUVEfMZCjH960Ip+LLkF/SukA=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=fEBpWuZMI5f1ITtXzDBgzx5iItfrlmMCtExT7IrgeGZeKJIZyePfm6qWjI9vODnna UWyFDDhVZabVaJ9bZY8BT0s64Y7rCxpsNWxYcb5A2KejRjp43IsfjO91mSNhdRRaOj xBMmeZG3sohkGZp3h7kYw+qOQh6qnI/S6THpHSGmwjTFU5pIaJ7IbMurNnCqS8Xo9S V/p4gNbFJWjKfbRQcJRH6sKrGBG0fxhdsxNnO0JYkh+O2khYqH8K/KJZTgxBWBec1A hu0HXWHfsJi2jkRxrUDaWw4omFyewPLLz92rqmt0jSFEXaA0FEdL0ZAc61FAxmCWnB FP2PccIYo8EzA== From: Miguel Ojeda To: Miguel Ojeda , Alex Gaynor Cc: Boqun Feng , Gary Guo , =?UTF-8?q?Bj=C3=B6rn=20Roy=20Baron?= , Benno Lossin , Andreas Hindborg , Alice Ryhl , Trevor Gross , Danilo Krummrich , rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org, patches@lists.linux.dev, Maarten Lankhorst , Maxime Ripard , Thomas Zimmermann , David Airlie , Simona Vetter , Jocelyn Falempe , dri-devel@lists.freedesktop.org Subject: [PATCH 01/10] drm/panic: add missing space Date: Mon, 24 Mar 2025 22:03:48 +0100 Message-ID: <20250324210359.1199574-2-ojeda@kernel.org> In-Reply-To: <20250324210359.1199574-1-ojeda@kernel.org> References: <20250324210359.1199574-1-ojeda@kernel.org> 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" Add missing space in sentence. This was found using the Clippy `doc_markdown` lint, which we may want to enable. Fixes: cb5164ac43d0 ("drm/panic: Add a QR code panic screen") Signed-off-by: Miguel Ojeda Acked-by: Danilo Krummrich Acked-by: Greg Kroah-Hartman Reviewed-by: Benno Lossin Reviewed-by: Jocelyn Falempe --- drivers/gpu/drm/drm_panic_qr.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/drivers/gpu/drm/drm_panic_qr.rs b/drivers/gpu/drm/drm_panic_qr= .rs index ecd87e8ffe05..9bd4d131f033 100644 --- a/drivers/gpu/drm/drm_panic_qr.rs +++ b/drivers/gpu/drm/drm_panic_qr.rs @@ -5,7 +5,7 @@ //! It is called from a panic handler, so it should't allocate memory and //! does all the work on the stack or on the provided buffers. For //! simplification, it only supports low error correction, and applies the -//! first mask (checkerboard). It will draw the smallest QRcode that can +//! first mask (checkerboard). It will draw the smallest QR code that can //! contain the string passed as parameter. To get the most compact //! QR code, the start of the URL is encoded as binary, and the //! compressed kmsg is encoded as numeric. --=20 2.49.0 From nobody Tue Dec 16 23:41:16 2025 Received: from smtp.kernel.org (aws-us-west-2-korg-mail-1.web.codeaurora.org [10.30.226.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 301931DE8A5; Mon, 24 Mar 2025 21:04:20 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=10.30.226.201 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1742850261; cv=none; b=trsLw3N6TfwHu/tZk8c5XZ/lQynMlwTlK4nbyqB2LgJAI9K/JfI/p0SPsvqIv1O7EpFRDFqgIqb4lE9E845CcpIHmbA1BqvRGC6cXZGsK4YDBWA/J4tcDRlw2lGWdyOsmNWd/nW1RCmBCjKgbJ8T3XOZILDMdkbmfsxDmxFLXX0= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1742850261; c=relaxed/simple; bh=UzO1Is65wUucYlG6zCoHXjenv9hb72i1myTEfKlskho=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=MnT0jae9uBqq+L9sqzXvuS/lybTXz3sIeP/vhMjlrKIXgAJ4JlXREVuJvSIJDOXBhyuY9TYgQ5qBT/EgcadSAuKeqHf3897W1+sVLhth0IGcfDs0raAZMWoXp7DdeZRd4e55pKB18LC2uS0xOLFLnIlnMRYH9MKYYd2AzvnEaj4= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=h4+igZhq; arc=none smtp.client-ip=10.30.226.201 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b="h4+igZhq" Received: by smtp.kernel.org (Postfix) with ESMTPSA id 2A75EC4CEDD; Mon, 24 Mar 2025 21:04:15 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1742850260; bh=UzO1Is65wUucYlG6zCoHXjenv9hb72i1myTEfKlskho=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=h4+igZhqO54dAYRBs+zJfRMVWtgbX3T5GhiNbnXs2j0tPYqLG+wQIPB9QEOQscOkY iU75GRTGoSJyxe3cTemmAeZOtKzoMCIVC4aOmjxLWSU04vEtHfSQnXcb/QNiNqjoDm Fkocgl/3sf3EPnzVQXBLCfXlHMPEKCRkQSK7hKlNkN+/3ZdFlOhNWusk+0eoxsE6gD Zif5P5Gl2WADshm8ZKGHe3NA7VECgcRFjzfkjrfLEDlij2jTbPWlCCA0Y0TeiJabnc v2pAe+R+VGMYXGHjq0D/UMsugsk5DfPldgs6BFVSBYZnhKR1Vi1NlAH3M8MkA6T5ki za/U0OzTFmC3A== From: Miguel Ojeda To: Miguel Ojeda , Alex Gaynor Cc: Boqun Feng , Gary Guo , =?UTF-8?q?Bj=C3=B6rn=20Roy=20Baron?= , Benno Lossin , Andreas Hindborg , Alice Ryhl , Trevor Gross , Danilo Krummrich , rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org, patches@lists.linux.dev, Maarten Lankhorst , Maxime Ripard , Thomas Zimmermann , David Airlie , Simona Vetter , Jocelyn Falempe , dri-devel@lists.freedesktop.org Subject: [PATCH 02/10] drm/panic: add missing Markdown code span Date: Mon, 24 Mar 2025 22:03:49 +0100 Message-ID: <20250324210359.1199574-3-ojeda@kernel.org> In-Reply-To: <20250324210359.1199574-1-ojeda@kernel.org> References: <20250324210359.1199574-1-ojeda@kernel.org> 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" Add missing Markdown code span. This was found using the Clippy `doc_markdown` lint, which we may want to enable. Fixes: cb5164ac43d0 ("drm/panic: Add a QR code panic screen") Signed-off-by: Miguel Ojeda Acked-by: Danilo Krummrich Acked-by: Greg Kroah-Hartman Reviewed-by: Benno Lossin Reviewed-by: Jocelyn Falempe --- drivers/gpu/drm/drm_panic_qr.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/drivers/gpu/drm/drm_panic_qr.rs b/drivers/gpu/drm/drm_panic_qr= .rs index 9bd4d131f033..a8f832598c70 100644 --- a/drivers/gpu/drm/drm_panic_qr.rs +++ b/drivers/gpu/drm/drm_panic_qr.rs @@ -914,7 +914,7 @@ fn draw_all(&mut self, data: impl Iterator= ) { /// will be encoded as binary segment, otherwise it will be encoded /// efficiently as a numeric segment, and appended to the URL. /// * `data_len`: Length of the data, that needs to be encoded, must be le= ss -/// than data_size. +/// than `data_size`. /// * `data_size`: Size of data buffer, it should be at least 4071 bytes t= o hold /// a V40 QR code. It will then be overwritten with the QR code image. /// * `tmp`: A temporary buffer that the QR code encoder will use, to writ= e the --=20 2.49.0 From nobody Tue Dec 16 23:41:16 2025 Received: from smtp.kernel.org (aws-us-west-2-korg-mail-1.web.codeaurora.org [10.30.226.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id F20CF1DF721; Mon, 24 Mar 2025 21:04:24 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=10.30.226.201 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1742850265; cv=none; b=nWoGXDxLgswImxNP3JI1BWmo7yYklLDt6pdgCfR9AW9YFGyV24zusiUTpa5I/KGj+Id+5Ra+/san3jhp+f38ayAhCQmutGZ1qkZBXMDC2DQKWapvwZQUDaL/SLjOkrrrof9915FqSvGUucuGOmKBJdU61u5hJh1MAS9R6jerdHY= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1742850265; c=relaxed/simple; bh=Q/RrBja5M4/phEPdp46qnyHArU8edGqutVl3iHroFBI=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=uHx80DSh0z9yr7/gSo6m3iugupGW6ygo10jLKbaKbddtx9h7ZMnoxll6rOqDoVFYE97wqJmeUDgKowhD5/oeQyyvWRG0X3TbzBuKNue95tBozGVUZpiu+mBBCPJlPMuGhofk8E7m10TUNTPM2x6M6E+u1BnDyTgZC2JHhgqwTf0= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=el92AXz2; arc=none smtp.client-ip=10.30.226.201 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b="el92AXz2" Received: by smtp.kernel.org (Postfix) with ESMTPSA id 45779C4CEE4; Mon, 24 Mar 2025 21:04:21 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1742850264; bh=Q/RrBja5M4/phEPdp46qnyHArU8edGqutVl3iHroFBI=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=el92AXz2vT1aNLjOMCb25p8Ywf8K27FY8t+MJXfGb8Sj0IKzxf4QNo1DXAURZbLIL xmMS8lqx5S8Ta5msjA+7qc0fvuHjeBH/AOK9lq/wKYDNB5f94KBuqzCQYbOruIyk52 ++69zOp+jo6BDwgwKLfLaw851Z1AsORnk+uYmhOzgKSqkg9L7ntMp+0imdO/S6nIJ3 VrP42naeKWGRkEWoJsWtsLd0Rrgxwadjo9D0g7CT0yHPK2Iev/s7bpWnO1HP5GqgKa ov4vi1dOtDYOEmoqJtMle5AyAvY7bAVekpsVrDpPfrVrn73MjCqYY4x9iTSgzN0qo5 ktOkoaTzvGUsg== From: Miguel Ojeda To: Miguel Ojeda , Alex Gaynor Cc: Boqun Feng , Gary Guo , =?UTF-8?q?Bj=C3=B6rn=20Roy=20Baron?= , Benno Lossin , Andreas Hindborg , Alice Ryhl , Trevor Gross , Danilo Krummrich , rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org, patches@lists.linux.dev, Wedson Almeida Filho Subject: [PATCH 03/10] rust: alloc: add missing Markdown code spans Date: Mon, 24 Mar 2025 22:03:50 +0100 Message-ID: <20250324210359.1199574-4-ojeda@kernel.org> In-Reply-To: <20250324210359.1199574-1-ojeda@kernel.org> References: <20250324210359.1199574-1-ojeda@kernel.org> 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" Add missing Markdown code spans. This was found using the Clippy `doc_markdown` lint, which we may want to enable. Fixes: b6a006e21b82 ("rust: alloc: introduce allocation flags") Signed-off-by: Miguel Ojeda Acked-by: Danilo Krummrich Acked-by: Greg Kroah-Hartman Reviewed-by: Benno Lossin --- rust/kernel/alloc.rs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/rust/kernel/alloc.rs b/rust/kernel/alloc.rs index fc9c9c41cd79..a2c49e5494d3 100644 --- a/rust/kernel/alloc.rs +++ b/rust/kernel/alloc.rs @@ -94,10 +94,10 @@ pub mod flags { /// /// A lower watermark is applied to allow access to "atomic reserves".= The current /// implementation doesn't support NMI and few other strict non-preemp= tive contexts (e.g. - /// raw_spin_lock). The same applies to [`GFP_NOWAIT`]. + /// `raw_spin_lock`). The same applies to [`GFP_NOWAIT`]. pub const GFP_ATOMIC: Flags =3D Flags(bindings::GFP_ATOMIC); =20 - /// Typical for kernel-internal allocations. The caller requires ZONE_= NORMAL or a lower zone + /// Typical for kernel-internal allocations. The caller requires `ZONE= _NORMAL` or a lower zone /// for direct access but can direct reclaim. pub const GFP_KERNEL: Flags =3D Flags(bindings::GFP_KERNEL); =20 --=20 2.49.0 From nobody Tue Dec 16 23:41:16 2025 Received: from smtp.kernel.org (aws-us-west-2-korg-mail-1.web.codeaurora.org [10.30.226.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 8E1601F4281; Mon, 24 Mar 2025 21:04:28 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=10.30.226.201 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1742850268; cv=none; b=K+iW75Hlnba5Y0vmf7II/in4Z7X+T8QqZYWx4KJnAjf9K/Npw1WBOQFx20Sko8FGyTmQi+WtruLQC2vaGt9t1Q+XQvNAquY9BRv45WPcGbXZUtMhyV1rBNTthxOZo7ntkPZZCN0YWvFMEYgf3DJdtYA7iDklOiRwJEu+LYmK+Qw= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1742850268; c=relaxed/simple; bh=raN/DrVca3eWEseg36QZs2qjbG2u7DBN1E3/rJC0TSY=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=bfLSoFbMoUQ+CigpriDMVt23tPG3JTX9Tb4OdpJKFgPQcS+CMU6vPA4ZH4xL/f/GLkVCY3ZBHycM/GylQ+HEn2ilFCbi2u0Diz6YU/euCu4Yt/bdCSG1c1Pw24x29rkVIDH+H2WO0s4RDOt7HneiCegRVMBio+wljqlpsrfb8Ew= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=VMU4GBld; arc=none smtp.client-ip=10.30.226.201 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b="VMU4GBld" Received: by smtp.kernel.org (Postfix) with ESMTPSA id 1E42FC4CEEE; Mon, 24 Mar 2025 21:04:24 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1742850268; bh=raN/DrVca3eWEseg36QZs2qjbG2u7DBN1E3/rJC0TSY=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=VMU4GBld/nQdkpBXYug2C/p9qV9t0uDvSU02BlLHGQO5KM4o84WiR6bt0VWyIo0zb mLHK8lcxDDyaRaGmQusldlQz5qgqWtVEH73KN7A2TP90WHkPDtj7lRD5yQQsWyqIP1 vMtr+fkyMhFZ3W/vaYaqX4NtP6flmZ8xZ4GE3LbPPR4Gvzq7xHlZnR1SroK0qdyhb8 TzEq/YvaXLNXjMS2ytnaH9nVBdoUF1eOsrlvAMOBEKB/WJrw+j+dv2wHd2x48jAbj0 sp7JbE8smYsqm3P8+15td+Gm3ICr4ragNDZOL6071CgWwMPAV/VDvV7mbMLORnFH9R P/57msj55mhMg== From: Miguel Ojeda To: Miguel Ojeda , Alex Gaynor Cc: Boqun Feng , Gary Guo , =?UTF-8?q?Bj=C3=B6rn=20Roy=20Baron?= , Benno Lossin , Andreas Hindborg , Alice Ryhl , Trevor Gross , Danilo Krummrich , rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org, patches@lists.linux.dev Subject: [PATCH 04/10] rust: alloc: add missing Markdown code span Date: Mon, 24 Mar 2025 22:03:51 +0100 Message-ID: <20250324210359.1199574-5-ojeda@kernel.org> In-Reply-To: <20250324210359.1199574-1-ojeda@kernel.org> References: <20250324210359.1199574-1-ojeda@kernel.org> 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" Add missing Markdown code span. This was found using the Clippy `doc_markdown` lint, which we may want to enable. Fixes: dd09538fb409 ("rust: alloc: implement `Cmalloc` in module allocator_= test") Signed-off-by: Miguel Ojeda Acked-by: Danilo Krummrich Acked-by: Greg Kroah-Hartman Reviewed-by: Benno Lossin --- rust/kernel/alloc/allocator_test.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/rust/kernel/alloc/allocator_test.rs b/rust/kernel/alloc/alloca= tor_test.rs index e3240d16040b..039cd1e36c21 100644 --- a/rust/kernel/alloc/allocator_test.rs +++ b/rust/kernel/alloc/allocator_test.rs @@ -4,7 +4,7 @@ //! of those types (e.g. `CString`) use kernel allocators for instantiatio= n. //! //! In order to allow userspace test cases to make use of such types as we= ll, implement the -//! `Cmalloc` allocator within the allocator_test module and type alias al= l kernel allocators to +//! `Cmalloc` allocator within the `allocator_test` module and type alias = all kernel allocators to //! `Cmalloc`. The `Cmalloc` allocator uses libc's `realloc()` function as= allocator backend. =20 #![allow(missing_docs)] --=20 2.49.0 From nobody Tue Dec 16 23:41:16 2025 Received: from smtp.kernel.org (aws-us-west-2-korg-mail-1.web.codeaurora.org [10.30.226.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id D54001F4739; Mon, 24 Mar 2025 21:04:32 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=10.30.226.201 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1742850272; cv=none; b=eikch1UIxCrE/msp2zivbDlrFnSrowtVXmSFSutTxSxejQb3ptAMnqqYRVdqXqOhuRHz2XflsrbANnfo8jxvgcnUWcjpSefLq18QvHnx7LdaV65YlOB13hwtln1PY5KQ/zNsdQMNOSG3rr58CFrzlgHg/oCgtqfMzsQvuocdflc= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1742850272; c=relaxed/simple; bh=0enSYOwK08uB3YnLYrHQQ3uuBPHb0fjo6/NAEt+1y+w=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=NHf+TVcC4eV6Bz+g9PWJHHpe9yZP4wdZiesaW53EOYETa/3kWmoSZ8z/StD2wLdMaHnJ57pfXykCAyHckLZpOIytOf+A/BYEAqnJm8jlDmg1pk0CMPefST14XiLquxcLX+BmKg6l9ObI4YF6jc4u+bbPmi97Wbx7L3k1TUpJQm0= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=spl0Fgsv; arc=none smtp.client-ip=10.30.226.201 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b="spl0Fgsv" Received: by smtp.kernel.org (Postfix) with ESMTPSA id AC742C4CEDD; Mon, 24 Mar 2025 21:04:28 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1742850272; bh=0enSYOwK08uB3YnLYrHQQ3uuBPHb0fjo6/NAEt+1y+w=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=spl0FgsvLeA4Nkl3liUcUnrM5Bv5Qrhr7J+CtS6tnLIj1W+GKeIO1FBa0fIDP/Zqq fxYUkKa5mu2q8j5J4/M7p/K6YJd+pfMZa5yY0SyGSjemn6SC7ev1farinhUL2rs61m sRq/i/yxlIyNJe4ZoNw80vzDfQ6IgprtTTGSUbQ9w/BkrcvXPZIJWrhvoLaSGtm8M3 9wqw6dGuaEjycfRNakj7cx8b72AyxEEothSjXqBZAiDht2s3ZrehY4xEgcdumPPfp7 HNmyCr4WwasIKdlPpWA6iv6i0XHewo9zN/RvWwDu/n0jgezRZ1ENBD5gq7xcbygXhz 58XBPfiPaeqmQ== From: Miguel Ojeda To: Miguel Ojeda , Alex Gaynor Cc: Boqun Feng , Gary Guo , =?UTF-8?q?Bj=C3=B6rn=20Roy=20Baron?= , Benno Lossin , Andreas Hindborg , Alice Ryhl , Trevor Gross , Danilo Krummrich , rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org, patches@lists.linux.dev, Abdiel Janulgue , Daniel Almeida , Robin Murphy Subject: [PATCH 05/10] rust: dma: add missing Markdown code span Date: Mon, 24 Mar 2025 22:03:52 +0100 Message-ID: <20250324210359.1199574-6-ojeda@kernel.org> In-Reply-To: <20250324210359.1199574-1-ojeda@kernel.org> References: <20250324210359.1199574-1-ojeda@kernel.org> 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" Add missing Markdown code span. This was found using the Clippy `doc_markdown` lint, which we may want to enable. Fixes: ad2907b4e308 ("rust: add dma coherent allocator abstraction") Signed-off-by: Miguel Ojeda Acked-by: Danilo Krummrich Acked-by: Greg Kroah-Hartman Reviewed-by: Benno Lossin --- rust/kernel/dma.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/rust/kernel/dma.rs b/rust/kernel/dma.rs index 8cdc76043ee7..35fd8a638473 100644 --- a/rust/kernel/dma.rs +++ b/rust/kernel/dma.rs @@ -94,7 +94,7 @@ pub mod attrs { pub const DMA_ATTR_ALLOC_SINGLE_PAGES: Attrs =3D Attrs(bindings::DMA_A= TTR_ALLOC_SINGLE_PAGES); =20 /// This tells the DMA-mapping subsystem to suppress allocation failur= e reports (similarly to - /// __GFP_NOWARN). + /// `__GFP_NOWARN`). pub const DMA_ATTR_NO_WARN: Attrs =3D Attrs(bindings::DMA_ATTR_NO_WARN= ); =20 /// Used to indicate that the buffer is fully accessible at an elevate= d privilege level (and --=20 2.49.0 From nobody Tue Dec 16 23:41:16 2025 Received: from smtp.kernel.org (aws-us-west-2-korg-mail-1.web.codeaurora.org [10.30.226.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 4092A1F4E54; Mon, 24 Mar 2025 21:04:36 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=10.30.226.201 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1742850277; cv=none; b=cMfGTldgHeWgHr4offSf1zSpxxDqGnwwC4ri4lBk+CNsRJSx35RdLbctIViwBRd894VugC9VBiubgU3B+bvSac7aA+eM1S9zE5b3Wl1P9i1qAGEyMrCBhjSQuCrhdshD0iz4q63kNsw4datFRbgdhEwVGB0alSOMcA6VglJMi+E= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1742850277; c=relaxed/simple; bh=K1Xbe+sschQc/Ffbiv9QVBNfgYYwO/d/wVbgAvn8+iA=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=J0ZHmAJYPSRPFNzHJBXUu4VTnlPRFDxjZ4fubmJo50Cp5lAWXHrxzC/JccDPflV0mfaF/8AW6xpiV3YUPGCTTPAgIbMA/0jVQFRXysWb4I3AyrOsSyxYDUvGIj1xzw/igktyBueqfS8o15gmrQ7gmH55qnbpkF3+27yFhG0rZXE= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=iCdrxbcB; arc=none smtp.client-ip=10.30.226.201 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b="iCdrxbcB" Received: by smtp.kernel.org (Postfix) with ESMTPSA id F08CFC4CEED; Mon, 24 Mar 2025 21:04:32 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1742850276; bh=K1Xbe+sschQc/Ffbiv9QVBNfgYYwO/d/wVbgAvn8+iA=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=iCdrxbcBP97Zz2LU9u2ySQzxqRicqz3IEJYFju65MU+Po2Od67XKI9kQR8nEcmkU0 vQwnoB069r6Ao6r1u7wPHAh6jbZNIP93TR4vj/SP2yZF8brA5FqXZNH+g5ZV3U8nLa 4bs/yqjIJnBz5mO1AGmg5cNU9jbyrMu6tI+OcGsIH7Azse8yW4pKzNTvSpw1NjmxVy dwagh7I/O0e9lGb9WHP1x9DnhzOQ+28wcSnKLcmVtl3iM8GQQELqrhp7EzlARDQO9F JrVxSgI0THxncDtoGAQbWRh0jvNz+pIenCsGfrNara9j5pohgCbsu5q7p7WTtitSTf IYVjH1bn+1+Jw== From: Miguel Ojeda To: Miguel Ojeda , Alex Gaynor Cc: Boqun Feng , Gary Guo , =?UTF-8?q?Bj=C3=B6rn=20Roy=20Baron?= , Benno Lossin , Andreas Hindborg , Alice Ryhl , Trevor Gross , Danilo Krummrich , rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org, patches@lists.linux.dev, Rob Herring , Saravana Kannan , Greg Kroah-Hartman , devicetree@vger.kernel.org Subject: [PATCH 06/10] rust: of: add missing Markdown code span Date: Mon, 24 Mar 2025 22:03:53 +0100 Message-ID: <20250324210359.1199574-7-ojeda@kernel.org> In-Reply-To: <20250324210359.1199574-1-ojeda@kernel.org> References: <20250324210359.1199574-1-ojeda@kernel.org> 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" Add missing Markdown code span. This was found using the Clippy `doc_markdown` lint, which we may want to enable. Fixes: bbe3b4d1580d ("rust: of: add `of::DeviceId` abstraction") Signed-off-by: Miguel Ojeda Acked-by: Danilo Krummrich Acked-by: Greg Kroah-Hartman Reviewed-by: Benno Lossin --- rust/kernel/of.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/rust/kernel/of.rs b/rust/kernel/of.rs index 04f2d8ef29cb..60ed551b50fb 100644 --- a/rust/kernel/of.rs +++ b/rust/kernel/of.rs @@ -4,7 +4,7 @@ =20 use crate::{bindings, device_id::RawDeviceId, prelude::*}; =20 -/// IdTable type for OF drivers. +/// `IdTable` type for OF drivers. pub type IdTable =3D &'static dyn kernel::device_id::IdTable; =20 /// An open firmware device id. --=20 2.49.0 From nobody Tue Dec 16 23:41:16 2025 Received: from smtp.kernel.org (aws-us-west-2-korg-mail-1.web.codeaurora.org [10.30.226.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id CB7081F5612; Mon, 24 Mar 2025 21:04:41 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=10.30.226.201 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1742850281; cv=none; b=PHGwjpQ4V8C5bx/SJlidOY/7H1wj9Gi2yUvl44d2Ja0XVjZARdZe2HMrQtY7ttb4V4VnZpHPjIULojkZhHhI+/LYY0ed5p/ylAaJRYMm9aKz/8m+8HNU63jQBwM4dw71R5VFL7AaDth6/IOiKkA1uHdeMxkakcD6RWXA1oW1Z1M= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1742850281; c=relaxed/simple; bh=uzAUre8yuO6JwarGjgA4aQIOBg6xu8RcbsiMQ1Dc8bw=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=diFSsx87ofeTsj/7V6ZahopNWaNcTQm6H4SdF2g2h9mxJrKXtUf7Auo+1ijTb/aHiK4fZMtcYHRz8qGc3yvSlaxvmDMn7FCjPcZdNQg5S81CnCGp9GmPr2/7PV91Yqe387LlqForlhmv8AAFmmun3fntd/8ctbtipL3AVe2YT7E= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=SPnkrEsX; arc=none smtp.client-ip=10.30.226.201 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b="SPnkrEsX" Received: by smtp.kernel.org (Postfix) with ESMTPSA id 68A81C4CEE4; Mon, 24 Mar 2025 21:04:37 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1742850281; bh=uzAUre8yuO6JwarGjgA4aQIOBg6xu8RcbsiMQ1Dc8bw=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=SPnkrEsXOmUDJzEecsqBY8IqTHbrzWVOIVp4ZH0q09kXxD0MATIitKGZPcE+kshve YKppWsQF7wqCekLU1SkD8x1R8mgXH3UUrR9HKkO89NRseE5hcn/M58CqxHR42TpEpX aGisoO4BJlS5Sn5gCiSDFSXKpqWonY4muGVaO/0pG0m0FbhY/lskx5PNGFvXxzIBxP bc+499waM6p/G4zL50h/jrA6NR+LVTCMxAxAFz/H0Gm9qmSnWclSx5dBpOUmnrR7Cp OHmf+WfFPztgtLq93HQS+9ydFtQvAWE6iNRAH7dDtDDRX5mCh70zPlUZoTJP2R6mCA ZxICxNHS/iDXQ== From: Miguel Ojeda To: Miguel Ojeda , Alex Gaynor Cc: Boqun Feng , Gary Guo , =?UTF-8?q?Bj=C3=B6rn=20Roy=20Baron?= , Benno Lossin , Andreas Hindborg , Alice Ryhl , Trevor Gross , Danilo Krummrich , rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org, patches@lists.linux.dev, Bjorn Helgaas , FUJITA Tomonori , Greg Kroah-Hartman , linux-pci@vger.kernel.org Subject: [PATCH 07/10] rust: pci: fix docs related to missing Markdown code spans Date: Mon, 24 Mar 2025 22:03:54 +0100 Message-ID: <20250324210359.1199574-8-ojeda@kernel.org> In-Reply-To: <20250324210359.1199574-1-ojeda@kernel.org> References: <20250324210359.1199574-1-ojeda@kernel.org> 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 particular: - Add missing Markdown code spans. - Improve title for `DeviceId`, adding a link to the struct in the C side, rather than referring to `bindings::`. - Convert `TODO` from documentation to a normal comment, and put code in block. This was found using the Clippy `doc_markdown` lint, which we may want to enable. Fixes: 1bd8b6b2c5d3 ("rust: pci: add basic PCI device / driver abstractions= ") Signed-off-by: Miguel Ojeda Acked-by: Danilo Krummrich Acked-by: Greg Kroah-Hartman Reviewed-by: Benno Lossin --- rust/kernel/pci.rs | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/rust/kernel/pci.rs b/rust/kernel/pci.rs index f7b2743828ae..99413607c2b6 100644 --- a/rust/kernel/pci.rs +++ b/rust/kernel/pci.rs @@ -115,7 +115,9 @@ macro_rules! module_pci_driver { }; } -/// Abstraction for bindings::pci_device_id. +/// Abstraction for the PCI device ID structure ([`pci_device_id`]). +/// +/// [`pci_device_id`]: https://docs.kernel.org/PCI/pci.html#c.pci_device_id #[repr(transparent)] #[derive(Clone, Copy)] pub struct DeviceId(bindings::pci_device_id); @@ -170,7 +172,7 @@ fn index(&self) -> usize { } } -/// IdTable type for PCI +/// `IdTable` type for PCI. pub type IdTable =3D &'static dyn kernel::device_id::IdTable; /// Create a PCI `IdTable` with its alias for modpost. @@ -221,10 +223,11 @@ macro_rules! pci_device_table { /// `Adapter` documentation for an example. pub trait Driver { /// The type holding information about each device id supported by the= driver. - /// - /// TODO: Use associated_type_defaults once stabilized: - /// - /// type IdInfo: 'static =3D (); + // TODO: Use `associated_type_defaults` once stabilized: + // + // ``` + // type IdInfo: 'static =3D (); + // ``` type IdInfo: 'static; /// The table of device ids supported by the driver. -- 2.49.0 From nobody Tue Dec 16 23:41:16 2025 Received: from smtp.kernel.org (aws-us-west-2-korg-mail-1.web.codeaurora.org [10.30.226.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 1E2DF1F4E5B; Mon, 24 Mar 2025 21:04:45 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=10.30.226.201 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1742850286; cv=none; b=FoZyC+7DGgQAWGHPKS7E7lBRz9CQkTCVixpU4p36F96yKWArEnt8HO/rh1zj87xlNtAGq8VEzpBGLVutQqVuqdekGaoX7/yQGlFXDuOMmYshzox9sdSGS87i2G5gL7sBOVedDVkPrIbdBxPaSoZTSKTH0oA9lSbqJ4TXuIdpfC8= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1742850286; c=relaxed/simple; bh=mHKeb8XQeBT7AknJSDbq+TI1Xp0mqj3SSJYVGRZPVMY=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=mRB28WQS9dXV8yByz1HRdsm4pUohrxgqxiDRiZvesdQTDGpaeJmzicasC9/a0B3Mkf+YGXhbBy4by0YRDC1RbZ33NjIfElk8r68AXAYt6bvhe9afubb/gnrGQvRzuNm8WsGF1IA4cEVM5ns+N1UYS8pdPYknCFs9PWqzQ3JcpmI= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=KO2bVP0Q; arc=none smtp.client-ip=10.30.226.201 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b="KO2bVP0Q" Received: by smtp.kernel.org (Postfix) with ESMTPSA id E4481C4CEDD; Mon, 24 Mar 2025 21:04:41 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1742850285; bh=mHKeb8XQeBT7AknJSDbq+TI1Xp0mqj3SSJYVGRZPVMY=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=KO2bVP0QCbiSlPBF7HbKfjISsbwpN3I2YuiLadpf+X4lQlNaC6Ko6SDimMgEEr02x 9OsH5OhSEz6w5GwNSleBC2ilKo8kcMJLI2zoadcmIQkh5zbQ7OConF5HpSGyURasnj fKxA8UwZisYul/Y4iaC6GOO55VLcV0VNn94wx09PD0lrmd7WecbysC6RdjgFcVqtFd tkh8uIItoqd7A1HzE+N27OqejS/3KaMwo01+3YMbQ0edwN+X9eel+bRomgBu82TrsE q84sJAdU6apr0YRk0M57ZSaY+3CXK7fnVHmYFbCOnzpwBdU4ag+YQ6S2M8ZsuLoi+O cJ5lr1bxLBrxQ== From: Miguel Ojeda To: Miguel Ojeda , Alex Gaynor Cc: Boqun Feng , Gary Guo , =?UTF-8?q?Bj=C3=B6rn=20Roy=20Baron?= , Benno Lossin , Andreas Hindborg , Alice Ryhl , Trevor Gross , Danilo Krummrich , rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org, patches@lists.linux.dev, Greg Kroah-Hartman , "Rafael J. Wysocki" , "Rob Herring (Arm)" Subject: [PATCH 08/10] rust: platform: fix docs related to missing Markdown code spans Date: Mon, 24 Mar 2025 22:03:55 +0100 Message-ID: <20250324210359.1199574-9-ojeda@kernel.org> In-Reply-To: <20250324210359.1199574-1-ojeda@kernel.org> References: <20250324210359.1199574-1-ojeda@kernel.org> 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" Convert `TODO` from documentation to a normal comment, and put code in block. This was found using the Clippy `doc_markdown` lint, which we may want to enable. Fixes: 683a63befc73 ("rust: platform: add basic platform device / driver ab= stractions") Signed-off-by: Miguel Ojeda Acked-by: Danilo Krummrich Acked-by: Greg Kroah-Hartman Reviewed-by: Benno Lossin --- rust/kernel/platform.rs | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/rust/kernel/platform.rs b/rust/kernel/platform.rs index 1297f5292ba9..2426eaf915bb 100644 --- a/rust/kernel/platform.rs +++ b/rust/kernel/platform.rs @@ -147,10 +147,11 @@ macro_rules! module_platform_driver { ///``` pub trait Driver { /// The type holding driver private data about each device id supporte= d by the driver. - /// - /// TODO: Use associated_type_defaults once stabilized: - /// - /// type IdInfo: 'static =3D (); + // TODO: Use associated_type_defaults once stabilized: + // + // ``` + // type IdInfo: 'static =3D (); + // ``` type IdInfo: 'static; /// The table of OF device ids supported by the driver. -- 2.49.0 From nobody Tue Dec 16 23:41:16 2025 Received: from smtp.kernel.org (aws-us-west-2-korg-mail-1.web.codeaurora.org [10.30.226.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id EB4CC1F5617; Mon, 24 Mar 2025 21:04:49 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=10.30.226.201 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1742850290; cv=none; b=NzO83B/PCKMRnyNPEn+quAz3XN0SyHCMD3eNNHeNuachvv6CC+FZ43G56/SgXXvxyke8cVrWJWPlJXAGo6lqYo4Hphg9LAaAKn58Pic2U3+VDLEsudEftCFQz4AAkmg+CRqqlj8cvy6Iemc+mRArKNPh/mgv+Pk7VNCjuwxipKQ= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1742850290; c=relaxed/simple; bh=5AgVBZOVIAXuOhpg55nMBMuordYAujIXO9NsJifEoAc=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=NCcCk3AnVK1Z3diiVYQKGxUG7ixn1iMeF5n1puwmosCF7r340X1z4+P8nVV6u5RdNsEz2CwTuQRaUtNUWXbpHHsyFCPVcMEIN55xKUU9UshTkJhmvg+xKKIbtVU6D6PyKn4idbBQfrzHfgbtYr7p9W5HMSnKT7RoVZSQr8JN4Jw= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=MnInPrYp; arc=none smtp.client-ip=10.30.226.201 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b="MnInPrYp" Received: by smtp.kernel.org (Postfix) with ESMTPSA id 36783C4CEED; Mon, 24 Mar 2025 21:04:46 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1742850289; bh=5AgVBZOVIAXuOhpg55nMBMuordYAujIXO9NsJifEoAc=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=MnInPrYpJDKZ7BOPtSNj6iTvROAnr9VVFvD9QdOAxvoFIxbfaZUKXmgKjv/bEslxb 7vow96kZIzCdrzRCfwIneyyCkeiPw4gv5OV6tWJeEbFCRD0BZNh3HTqgRvQovznUoS 9uQIg6oXASaiMiLNxnIeqrgIVXQhzHDqntwJnaA6lMNcXSoberALszWtH0v3TzDaU/ tUKzMgYz/G/OPEJESt/tpdkAsbMarU/y3LRedoCsGHtS9UxS5XY5phtRxBuUfDzAkC RZqiZsGyvb3MlbVHXIRoYxgAMyb34z6KzektcNQq/4NdkwOQUMRrh6R6YH42E1sMbx oczp5F4lTKJBw== From: Miguel Ojeda To: Miguel Ojeda , Alex Gaynor Cc: Boqun Feng , Gary Guo , =?UTF-8?q?Bj=C3=B6rn=20Roy=20Baron?= , Benno Lossin , Andreas Hindborg , Alice Ryhl , Trevor Gross , Danilo Krummrich , rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org, patches@lists.linux.dev, Christian Brauner Subject: [PATCH 09/10] rust: task: add missing Markdown code spans and intra-doc links Date: Mon, 24 Mar 2025 22:03:56 +0100 Message-ID: <20250324210359.1199574-10-ojeda@kernel.org> In-Reply-To: <20250324210359.1199574-1-ojeda@kernel.org> References: <20250324210359.1199574-1-ojeda@kernel.org> 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" Add missing Markdown code spans and also convert them into intra-doc links. This was found using the Clippy `doc_markdown` lint, which we may want to enable. Fixes: e0020ba6cbcb ("rust: add PidNamespace") Signed-off-by: Miguel Ojeda Acked-by: Danilo Krummrich Acked-by: Greg Kroah-Hartman Reviewed-by: Benno Lossin --- rust/kernel/task.rs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/rust/kernel/task.rs b/rust/kernel/task.rs index 49012e711942..ca1209b997c4 100644 --- a/rust/kernel/task.rs +++ b/rust/kernel/task.rs @@ -156,10 +156,10 @@ fn deref(&self) -> &Self::Target { } } =20 - /// Returns a PidNamespace reference for the currently executing task'= s/thread's pid namespace. + /// Returns a [`PidNamespace`] reference for the currently executing t= ask's/thread's pid namespace. /// /// This function can be used to create an unbounded lifetime by e.g.,= storing the returned - /// PidNamespace in a global variable which would be a bug. So the rec= ommended way to get the + /// [`PidNamespace`] in a global variable which would be a bug. So the= recommended way to get the /// current task's/thread's pid namespace is to use the [`current_pid_= ns`] macro because it is /// safe. /// --=20 2.49.0 From nobody Tue Dec 16 23:41:16 2025 Received: from smtp.kernel.org (aws-us-west-2-korg-mail-1.web.codeaurora.org [10.30.226.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 12E011F63EA; Mon, 24 Mar 2025 21:04:54 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=10.30.226.201 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1742850294; cv=none; b=JO8dImo6/M/jdY0Vb/HDzAiSqset0Ps44ghf2RIGQyEqAMaYNAfO1inM8Q7zsgs9g/HlQ5zx1Pu6/enWFbcpxOVAA6uGkaxWhxxNJPudlNBiTlrZmW25R5/h1qm/2x+uhMxCqj9HzUGrTnO16Ff7wNZTU6a8rdITQ/kwDs9pRQs= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1742850294; c=relaxed/simple; bh=IoWE258jBNh0ra+jL8hEbT1/vCRHyQAdmsEh1LGLEZA=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=PCznK+hMQNdD0seNT4mDCGXBDJUX5pDp76fwTiAgbJ/OYgzM7MKa9NXGElFcSvFsrAZk690Szr3KUg1x7gQ01kctYyxfPdy34JO1mDvlPJ+tPNfnW1v5R8mS49uPc9SKokDJAQkv+fSptqepPJObp9LUdvTugW+iVQPQayizrjg= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=AtatxKBw; arc=none smtp.client-ip=10.30.226.201 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b="AtatxKBw" Received: by smtp.kernel.org (Postfix) with ESMTPSA id 19F2CC4CEDD; Mon, 24 Mar 2025 21:04:49 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1742850293; bh=IoWE258jBNh0ra+jL8hEbT1/vCRHyQAdmsEh1LGLEZA=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=AtatxKBwUWEFzs9NFsD5TDKT/oTA8vvrlwxDxjjAe5HH2OYZVu2NlD6SdKVLlPgLE JP3rBeBRHA+CL9XJZKzKdtMO/yVGmm8lS4yU2T14kTBc/IxbWM1IZ+B5Z4IaZcxb47 MqBRNREidIjBaJZKGgD1sWMLa0RyxVIKYQJhOmfcmCwotJxhf5s4wyxxvHYoN7qS7i ETfXt7id9HDNhCAhqkaZinlZarQdNG3gu+4gc3n8vQ+x8CEdo//KVCAGu5OTzSWkHj +XTJpHJj9z3tbWqZB6gL94P254qID2RYsr9DVk5IemZku4cAxKdsjFQ7F58x3nNNEf yjDS4NIBVCvmQ== From: Miguel Ojeda To: Miguel Ojeda , Alex Gaynor Cc: Boqun Feng , Gary Guo , =?UTF-8?q?Bj=C3=B6rn=20Roy=20Baron?= , Benno Lossin , Andreas Hindborg , Alice Ryhl , Trevor Gross , Danilo Krummrich , rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org, patches@lists.linux.dev, Masahiro Yamada , Nathan Chancellor , Nicolas Schier , linux-kbuild@vger.kernel.org Subject: [RFC PATCH 10/10] rust: kbuild: enable `doc_markdown` Clippy lint Date: Mon, 24 Mar 2025 22:03:57 +0100 Message-ID: <20250324210359.1199574-11-ojeda@kernel.org> In-Reply-To: <20250324210359.1199574-1-ojeda@kernel.org> References: <20250324210359.1199574-1-ojeda@kernel.org> 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" Clippy supports the `doc_markdown` lint [1] since 2016 [2]: Checks for the presence of _, :: or camel-case words outside ticks in documentation. It is a very common note in Linux kernel reviews to mention that documentation is missing a Markdown code span, e.g.: /// Length of the data must be less than data_size. should have been: /// Length of the data must be less than `data_size`. This lint can identify some of those cases automatically for us. It also caught for us other typos or mis-documentation, such as a missing code block. Thus enable it, now that the tree is sufficiently clean. Relatedly, it would be nice to have something similar [3] even for comments (not just documentation), as well as for possible intra-doc links (which should also have less false positives). Link: https://rust-lang.github.io/rust-clippy/master/index.html#doc_markdow= n [1] Link: https://github.com/rust-lang/rust-clippy/commit/42bf37f49f49829507be4= f2dfd6c5db9b8234b66 [2] Link: https://github.com/rust-lang/rust/issues/131510 [3] Link: https://lore.kernel.org/rust-for-linux/CANiq72=3DaVRMvOaU48DBLL=3Dp+V= oG3RvHK+K48XQhvHw3ARc0BNg@mail.gmail.com/ Signed-off-by: Miguel Ojeda Acked-by: Danilo Krummrich Acked-by: Greg Kroah-Hartman Reviewed-by: Benno Lossin --- .clippy.toml | 4 ++++ Makefile | 1 + 2 files changed, 5 insertions(+) diff --git a/.clippy.toml b/.clippy.toml index 815c94732ed7..adc32c88176c 100644 --- a/.clippy.toml +++ b/.clippy.toml @@ -9,3 +9,7 @@ disallowed-macros =3D [ # it here, see: https://github.com/rust-lang/rust-clippy/issues/11303. { path =3D "kernel::dbg", reason =3D "the `dbg!` macro is intended as = a debugging tool" }, ] + +doc-valid-idents =3D [ + "KUnit", +] diff --git a/Makefile b/Makefile index 70bdbf2218fc..5d6baedc097f 100644 --- a/Makefile +++ b/Makefile @@ -477,6 +477,7 @@ export rust_common_flags :=3D --edition=3D2021 \ -Wrust_2018_idioms \ -Wunreachable_pub \ -Wclippy::all \ + -Wclippy::doc_markdown \ -Wclippy::ignored_unit_patterns \ -Wclippy::mut_mut \ -Wclippy::needless_bitwise_bool \ -- 2.49.0