From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from smtp.kernel.org (aws-us-west-2-korg-mail-alma10-1.taild15c8.ts.net [100.103.45.18]) (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 70E2B3C3BFD; Thu, 25 Jun 2026 10:16:37 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=100.103.45.18 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1782382598; cv=none; b=U8xdjU1VogcDRiftdmdJZq2YTckKKPDVM51apTok/FkYojCugtyXqfDMOhvJ+6CsEEhy5IKFtgn92XOGfUBO+8Rr2OsSk9eohODPG2k4KrOeWEaBdn+5DuZhUaN2B6n/qf89q6rUkhF59CyoO9kRU+hJoq4HlnxWTG/OXbi6BkE= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1782382598; c=relaxed/simple; bh=xtRqZqvWwHRJc8vR4Ipyb8GazR+NJYeIvkQ13em4zYw=; h=From:Date:Subject:MIME-Version:Content-Type:Message-Id:References: In-Reply-To:To:Cc; b=sO5faffQ2y9+2vRrMEaxnBYgBEuhKb7P2oaKEUoXhegwm5L0b72xlEqVf8uA+O7M0preBpJnn7PniPgIuap745/ldLdhdwCQalShJ0SuIxpgokG5yHZ7EbBrJR6Eok2+HGW4a7C3n0gkANyyKocSniba/0F5CWJCL5BqMlIxY5s= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=YTgJGiX7; arc=none smtp.client-ip=100.103.45.18 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b="YTgJGiX7" Received: by smtp.kernel.org (Postfix) with ESMTPSA id 070881F000E9; Thu, 25 Jun 2026 10:16:26 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=kernel.org; s=k20260515; t=1782382597; bh=CNtLwpUtBCbwlzY1FvJc65Jza7fCnLIGQublYFNRjfM=; h=From:Date:Subject:References:In-Reply-To:To:Cc; b=YTgJGiX7vpyvr1NvkO81NSfF9NRnSAG4Bm8DJZ7Y2R1T1Cw8wt0gR/PKCFkpXnPb8 FWy6JRJXrznxqNKGvKEY/OWYWpwJR8DaHKi9qLa7wQTNd9IggrblryapVC6sK366ME 8kqh4NT60QYoNd8798HmcKigcLQe4Vq3P3o2tC2la+DlAd2Om8Viun+FT9UHlXyNym +Ipb+RgXazvoNwvmDp5qLDMA6Wt/bZFCtVZGjQ9meQE5aKM4H/IKPn+Cu8yf2Tfgek pblBYNYclxI2Jm00S3zcHcXGsTUfwcbM7n7ha6kTtJXkIcg3I0bcrxtjJu0a2AOxce HkybxcqPNGQMw== From: Andreas Hindborg Date: Thu, 25 Jun 2026 12:15:08 +0200 Subject: [PATCH v18 6/8] rust: Add missing SAFETY documentation for `ARef` example Precedence: bulk X-Mailing-List: driver-core@lists.linux.dev List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: 7bit Message-Id: <20260625-unique-ref-v18-6-4e06b5896d47@kernel.org> References: <20260625-unique-ref-v18-0-4e06b5896d47@kernel.org> In-Reply-To: <20260625-unique-ref-v18-0-4e06b5896d47@kernel.org> To: Danilo Krummrich , Lorenzo Stoakes , Vlastimil Babka , "Liam R. Howlett" , Uladzislau Rezki , Miguel Ojeda , Boqun Feng , Gary Guo , =?utf-8?q?Bj=C3=B6rn_Roy_Baron?= , Benno Lossin , Alice Ryhl , Trevor Gross , Daniel Almeida , Tamir Duberstein , Alexandre Courbot , =?utf-8?q?Onur_=C3=96zkan?= , Lyude Paul , Greg Kroah-Hartman , =?utf-8?q?Arve_Hj=C3=B8nnev=C3=A5g?= , Todd Kjos , Christian Brauner , Carlos Llamas , "Rafael J. Wysocki" , Dave Ertman , Ira Weiny , Leon Romanovsky , Paul Moore , Serge Hallyn , David Airlie , Simona Vetter , Alexander Viro , Jan Kara , Igor Korotin , Viresh Kumar , Nishanth Menon , Stephen Boyd , Bjorn Helgaas , =?utf-8?q?Krzysztof_Wilczy=C5=84ski?= , Pavel Tikhomirov , Michal Wilczynski Cc: Andreas Hindborg , Philipp Stanner , rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org, linux-mm@kvack.org, driver-core@lists.linux.dev, linux-block@vger.kernel.org, linux-security-module@vger.kernel.org, dri-devel@lists.freedesktop.org, linux-fsdevel@vger.kernel.org, linux-pm@vger.kernel.org, linux-pci@vger.kernel.org, linux-pwm@vger.kernel.org, Oliver Mangold X-Mailer: b4 0.16-dev X-Developer-Signature: v=1; a=openpgp-sha256; l=1545; i=a.hindborg@kernel.org; h=from:subject:message-id; bh=2xO30Rq3QXTxoSgZh5GHqcI6JrKIaWz8NtlqTYC+5S8=; b=owEBbQKS/ZANAwAKAfpQKQiqxb3QAcsmYgBqPP/COqKlKjyz/MXA1Y/ln7gilkEOsT25qZw22 Rb6scm4wFOJAjMEAAEKAB0WIQRXitnI2WZ2JirAaob6UCkIqsW90AUCajz/wgAKCRD6UCkIqsW9 0NcWEAC0tVyWWHIsH7WmwyHeTcRIIcSyA+jVURLu5J0VYFDajTnEyZ+As4AP3z2c3lUdJ6E0orl 1PL9KegXdlRowzXbknFM1TtxCHxyv0r1NLU4LirMxIGrPVxVdS2cKzRU8a4gLhBmCdVNre1PZLJ 4J/CxV8CpnFJ/NGp7bvsyrmDahOTm3RPr8VYu3NEWzN91Chnzo0WR4N3kHcTCaoaD9N7pfgkfXN SnkyJwR/QnqnMekRr2mxSexRHKKesWCkucCw4gV4EU8Ht7NiBUtUbTRN0DxmhQu3fYYAgMGTwh9 DTTHtgGRJ073AyQSH/+7GS1nCzIoGFt0P0iEq0NlGdJEs7PIOVwNgKAF7Ld7Nw/qp05kjay6rgN 2RIMd7ow1N4T0KveKCVRwhxBl6Af2jClTGzCRz2qO1grRMZM23A3Jnn70x713gbn6iSwTCGx0ez hCSZQA7KFhlo16eTeqjqI5pcW4TJlgxmjBlxZ3JwaDa6C7Is2kGZb9crSVRNsOIY8nP9tu71pWn 6Zkkodq0JN43u0YjJzndrbhsXcoZQHsdTSexPf2zYG3OJ7yV8JfAvw+1cLWuyfCLaztHTz+PRwq xSjZ5qf2Tv3i0nNUbnvZoBqU71LWOHzACaLAoOpGekVZMfB9afZne9LP/W13DEjw/HUjuOCIOxu gEx8/vZmtx3o8YQ== X-Developer-Key: i=a.hindborg@kernel.org; a=openpgp; fpr=3108C10F46872E248D1FB221376EB100563EF7A7 From: Oliver Mangold SAFETY comment in rustdoc example was just 'TODO'. Fixed. Signed-off-by: Oliver Mangold Reviewed-by: Daniel Almeida Co-developed-by: Andreas Hindborg Signed-off-by: Andreas Hindborg --- rust/kernel/sync/aref.rs | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/rust/kernel/sync/aref.rs b/rust/kernel/sync/aref.rs index fb7466a362741..d0865aeb9371b 100644 --- a/rust/kernel/sync/aref.rs +++ b/rust/kernel/sync/aref.rs @@ -142,7 +142,9 @@ pub unsafe fn from_raw(ptr: NonNull) -> Self { /// /// struct Empty {} /// - /// # // SAFETY: TODO. + /// // SAFETY: The `RefCounted` implementation for `Empty` does not count references and never + /// // frees the underlying object. Thus we can act as owning an increment on the refcount for + /// // the object that we pass to the newly created `ARef`. /// unsafe impl RefCounted for Empty { /// fn inc_ref(&self) {} /// unsafe fn dec_ref(_obj: NonNull) {} @@ -150,7 +152,7 @@ pub unsafe fn from_raw(ptr: NonNull) -> Self { /// /// let mut data = Empty {}; /// let ptr = NonNull::::new(&mut data).unwrap(); - /// # // SAFETY: TODO. + /// // SAFETY: We keep `data` around longer than the `ARef`. /// let data_ref: ARef = unsafe { ARef::from_raw(ptr) }; /// let raw_ptr: NonNull = ARef::into_raw(data_ref); /// -- 2.51.2