From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id A7F6EC5DF81 for ; Mon, 24 Aug 2026 11:19:53 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id C20B56B00A2; Mon, 24 Aug 2026 07:19:52 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id BD1B66B00A3; Mon, 24 Aug 2026 07:19:52 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id AC1026B00A4; Mon, 24 Aug 2026 07:19:52 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0016.hostedemail.com [216.40.44.16]) by kanga.kvack.org (Postfix) with ESMTP id 889C56B00A2 for ; Mon, 24 Aug 2026 07:19:52 -0400 (EDT) Received: from smtpin10.hostedemail.com (lb01a-stub [10.200.18.249]) by unirelay06.hostedemail.com (Postfix) with ESMTP id 1F4CCA333A for ; Mon, 24 Aug 2026 11:19:52 +0000 (UTC) X-FDA: 85135918224.10.A465F75 Received: from sea.source.kernel.org (sea.source.kernel.org [172.234.252.31]) by imf31.hostedemail.com (Postfix) with ESMTP id 603EF20002 for ; Mon, 24 Aug 2026 11:19:50 +0000 (UTC) Authentication-Results: imf31.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20260515 header.b=cvBIFLRA; dmarc=pass (policy=quarantine) header.from=kernel.org; spf=pass (imf31.hostedemail.com: domain of a.hindborg@kernel.org designates 172.234.252.31 as permitted sender) smtp.mailfrom=a.hindborg@kernel.org ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1787570390; h=from:from:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:dkim-signature; bh=vL9knM2sUgbCQ85ffU5z6/s6VECuwJ6C1a0TUUfpb00=; b=faO5Wq+DoJ8gtNFXLHBeziZlyYsrOxNrMdV76pB6dbLCXuXSQPSmKG3Ena1pMBLw4ACu+C 0Fyr8Tm8E38SDaKdxGsBmdQUaxp4tZ4kuTJ2232Zc3KxHtMIxjGlCqT2FGJnVJakn82lbX eL2OJTeZwG1NvgsC1514eC9PZwDHYgg= ARC-Authentication-Results: i=1; imf31.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20260515 header.b=cvBIFLRA; dmarc=pass (policy=quarantine) header.from=kernel.org; spf=pass (imf31.hostedemail.com: domain of a.hindborg@kernel.org designates 172.234.252.31 as permitted sender) smtp.mailfrom=a.hindborg@kernel.org ARC-Seal: i=1; a=rsa-sha256; d=hostedemail.com; s=arc-20220608; cv=none; t=1787570390; b=DjFXukz6sNcphqjPgH3zo1lv/FuOc56q9mcOSFmqu6KCU3kfwlYvNKMPDR3Xn9ZryJmXqQ 3g7IOvqHhOsxJFc12hkx8c2DQXKtprrtBPfVnG+0exxzfj9HQLZZAhhIkHLASq+MqehL3b E8dTqBTBKqBJAQVWKUyA3VoOFHBEEoE= Received: from smtp.kernel.org (quasi.space.kernel.org [100.103.45.18]) by sea.source.kernel.org (Postfix) with ESMTP id 8F47D42ADB; Mon, 24 Aug 2026 11:19:49 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id D12E71F00A3D; Mon, 24 Aug 2026 11:19:38 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=kernel.org; s=k20260515; t=1787570389; bh=vL9knM2sUgbCQ85ffU5z6/s6VECuwJ6C1a0TUUfpb00=; h=From:Date:Subject:References:In-Reply-To:To:Cc; b=cvBIFLRAcda2SZw/JlrD6tOLwNfKcnVd5E0WZoutY+y8hwmHZ/O/6Ev8gSNNOk796 R9vzEKuzdU0JQlwzbt/QCuq/vSRRoGFOgPbM7S8qMbmJ31pomA9Bx0DwWWtdXzPlcJ bjqOkSYxUEiNaBuOeH/wCMIyUw00fVSUWBMUKNuSXr6xs7IYK90q3cYemRq+iSN3Lp 5axDKiwZnhzf+2oCzUZiWtQn6Kack0hljwkugFf8B+PubZOZIRefgqHcsw1k1iK5TA pDNaW/raJJsv5Pm3utpa3a0gclsIoz8iz81EkexgcN3hfv/tI6cRuS9m/tkdjkhWCO XETF1EOKtNWPw== From: Andreas Hindborg Date: Mon, 24 Aug 2026 13:17:58 +0200 Subject: [PATCH v20 6/8] rust: Add missing SAFETY documentation for `ARef` example MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: 7bit Message-Id: <20260824-unique-ref-v20-6-490735672187@kernel.org> References: <20260824-unique-ref-v20-0-490735672187@kernel.org> In-Reply-To: <20260824-unique-ref-v20-0-490735672187@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 , 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 , Ira Weiny , Ira Weiny 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, linux-usb@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=Ze2x5FAumXdrYYXBmcLdm4zoQ8i0F4uXb1KFrUnACjQ=; b=owEBbQKS/ZANAwAKAfpQKQiqxb3QAcsmYgBqjCiF6dh93QL76FsS3p7E0fXhPzyq7P6N7DBZg tiDSEuYy0eJAjMEAAEKAB0WIQRXitnI2WZ2JirAaob6UCkIqsW90AUCaowohQAKCRD6UCkIqsW9 0EkxD/0XM2c5th1h+pGWV6+q9sYgp81vNSAgToV6NWXab5X9Q41O3etvl4v1UKRuRknTeiCNln7 bdnWb7sf1ddcFR8ctDx7tKS1lyYDHeUT/VJzXWcKqQXtyaCjA+VBSZB++jWxz4eN3rfSR7GGLa/ PYUcrMQb3iNL7Fevrhvf4Tyj3IpFO95jaD1CNRpzQhqi5LFH+Dytg5TPMQLqIumEu4c8+b4t4UN eaR+Mvh/nBqPnjt/+0gfZGf9l1GN2VaOKj0BS0ubxibuJizarHIvv+PrZp3iwViSVF+h/SDC7rD 1ENtCS0a3zosJOc6hENkAzE5dI5c0eOBNs/pTaL+DicoOuNfO+FfTdMUCcuU/hKQ4XUEYrtPAcQ 2favBhHsZtH/gFr3Yjp19Vim0e/AiN3wVfmUHOHyinDd6vKgAoQEoZSvoDS20gDM58r1hMtN7Nc nbYGLRNRRz35IroNM4ReUJZ1u9Jg0MbwAhOQufvDKBPYsqUOoEwdLJyCZnnIZ29b2UQnr/Vzh8Z 7YPxMftrFJ5plKtEN0l9k4/KUzmhXfm+Le1zc1Lu74+OJHSl69zrN8kJFSPgCIqgPm5T5BL3/8n hsRCDyVeRiNXPfeq/4NxDWzlzJzTQbtE7XvlK3N9hl98xNr/tfa9Qfk8IyEcKJwFzzffLjXpFIR X6nSbfz4HsnxrIA== X-Developer-Key: i=a.hindborg@kernel.org; a=openpgp; fpr=3108C10F46872E248D1FB221376EB100563EF7A7 X-Stat-Signature: 5o9cigju13rd3qxf1p4hkp78s3sk9j3y X-Rspamd-Queue-Id: 603EF20002 X-Rspamd-Server: rspam03 X-Rspam-User: X-HE-Tag: 1787570390-917069 X-HE-Meta: U2FsdGVkX18hnnK3UG+MMkm+t3rLfE8empyuQelBCuwwaAJ/feLEYwnwwd9isc0I7Zf75y250vEHh+9twtt/KKqkDJtuFRQPMvB4hs7SxxRDPw8ltXH00PiP5Ddnc/VWvzaIkj+HJtRXbIbLiVm20HMIlr/Av48NrXxegs4vY7k0yE2OdBF7aPu0RuyWbas6+CKhvK3eariyoFFELzyVS4gfZs4oLJt0sC6TBgj0fg1tWbzy19p5kWMuZMIMS9GwSFhFcVkXOPGfKhZDmMKnuJNBay+eJ9NraIUV/LF8BNexdNJ95cQxD4BEAx3Cw7gNipROIT79Qz/wJ6tagJzoUJSifVJMh3jqDt7Qt/IBcvp/MafON8cl4EuQNQ9dCx2zD9AhsjRjX1fa4SLwSp+GHPhscQoH84HoTaVf159zOcJy728x38RHkeQto7HV4vxtDZFlf7iVkcV3oUJLscSwVYIwWAKzA4gRoFMABDWtNgYyHp4V4YtJgYi+QMx1BYWXttGOMMy9jw4Lmzk619aBC7jBGPsydXfrGbeP3ugIP36B6quJS6f2jClAV06pp+JkruMS4Ais2GxMBYwPxMrVed5K79cMFEAp0n2b6fO4nA7fNrNWaiHuSr2xf/L1RMkH//1TDB56mzfK6WsHgiLaSs7LED0LEMYijzyE0ls39Sr10yLOtPuiFRhwSU2jSdTFxyFj8i/zYIMZcpPfTmRLe+qn2OkDq0+Xs//jFcT3X1dwFBpTbcXkkJNqMnUTyiugvoQPX8A0qJAIbqms27UvbVb4QEG/vo3IguMSbw76f//agtYlEiVYXZuvE3uU+QmvOqIwpdfUrqgwukofiHGw/RRi4BVeu7Vm/3ALGZykhbtaaguCW6qiB8INRRLr0ezGkY+FyDYR8Fi7O2rWPKe+tUYcMxSbTZ+B9d6B+kSfrs6V8z52yAa2zsKFmYRInuqoKrqLQxIy4I30oK9DKnP 71TMCtRm ZQ689q/Jc19icE6TxtpDl5O8SIGxoZ3qO1y/NCCkA2/Ywr+rzV4ABWXlNBuZ1zWETSlRexYpTdQGXwXnwGCrPSoXsxq7cWUyAdbbfjXLIpHjiT+56YP+3taUshs2gx56pqxs47/AZiEUH24666G83ECseM/S75ddljMr8/mIY7uzmrQy08ow+OHXRIdBsovTOE+++s4r3DOch/lElt/i6RHU1KLmn9PXGRG6sjZophkM37QCUtELAe4U5b+jcLY2GMnoMhLmgUFZbjArc8wXk9ZH6NnoWVJVLjhQ/aYsTBrXST92rW0Xn5QSHNeHRMxbS2T3R5CnChVMbOR0XfhHlpEgo5A== Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: List-Subscribe: List-Unsubscribe: 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 ea5a16b8163a6..f26ca39b84d0d 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