From nobody Sat Oct 4 08:03:05 2025 Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) (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 8F49C33A01D for ; Tue, 19 Aug 2025 20:13:57 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=170.10.129.124 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1755634439; cv=none; b=pzhP+cxzjz3mudVv3ENUi9VW+shVwIZZYjbHeKG+usLXh3k0OvCFjt2Vbrmx1ZpjNSZsLIJskgDMzuEnc7jdaYVyDwURY0vitO+EnBNBzoOR0GwhPr3jD5XDS9TJwCaJsemhJpYtl1SnChkAcDTvHLnmpXqCygdLjcPOzaGllc8= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1755634439; c=relaxed/simple; bh=qlwaWio57GqLMA9Fb4mvAHFlhGAkvsC98uuNEQObk/w=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=p21mgyvh2Qtoarf2Vns3fhIJTd/zf4FhQ2Gk9rtOAxKsvwpEZhlXYjjk+l7E7htKmM3NkkNHuImZamyPhrHrdZzsBklIVdJfLNTdLuMulMV1imQOe/gDyqKarslMQL1oqQrJVrTdM9Vg/agD3Fj9B+/yXrxLYsgFM8b0FleqHyE= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=quarantine dis=none) header.from=redhat.com; spf=pass smtp.mailfrom=redhat.com; dkim=pass (1024-bit key) header.d=redhat.com header.i=@redhat.com header.b=V0bUasNc; arc=none smtp.client-ip=170.10.129.124 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=quarantine dis=none) header.from=redhat.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=redhat.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (1024-bit key) header.d=redhat.com header.i=@redhat.com header.b="V0bUasNc" DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1755634436; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=BLWwbEpsyDLokTeeRPGfQvr4ehtZaUWiSPjkeJIZb9w=; b=V0bUasNcVBKNDC+XAM5lZ92CzIsAIDwNDSdV3ao7k7NKaJa1F/m89pb431ZpbUwvJ8b5/A WiY6+bR7lJbBq+fHD4ioW7KRZ01AKpFJUTC9UXjx+ygwm85gWFZqVm3XyF4P1Z+1qw2kT1 hu/hvI4fwypTIYgimKPAw9BcXjlQ1uk= Received: from mx-prod-mc-06.mail-002.prod.us-west-2.aws.redhat.com (ec2-35-165-154-97.us-west-2.compute.amazonaws.com [35.165.154.97]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-671-TC37_-DtM7OxnJDbkICEGg-1; Tue, 19 Aug 2025 16:13:51 -0400 X-MC-Unique: TC37_-DtM7OxnJDbkICEGg-1 X-Mimecast-MFC-AGG-ID: TC37_-DtM7OxnJDbkICEGg_1755634428 Received: from mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.12]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mx-prod-mc-06.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id A94701800561; Tue, 19 Aug 2025 20:13:48 +0000 (UTC) Received: from chopper.redhat.com (unknown [10.22.81.238]) by mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id 7464219560B0; Tue, 19 Aug 2025 20:13:44 +0000 (UTC) From: Lyude Paul To: rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org, Thomas Gleixner , Andreas Hindborg , FUJITA Tomonori Cc: Daniel Almeida , Boqun Feng , Frederic Weisbecker , Anna-Maria Behnsen , John Stultz , Stephen Boyd , Miguel Ojeda , Alex Gaynor , Gary Guo , =?UTF-8?q?Bj=C3=B6rn=20Roy=20Baron?= , Benno Lossin , Alice Ryhl , Trevor Gross , Danilo Krummrich Subject: [PATCH v8 1/7] rust: hrtimer: Document the return value for HrTimerHandle::cancel() Date: Tue, 19 Aug 2025 16:05:52 -0400 Message-ID: <20250819201334.545001-2-lyude@redhat.com> In-Reply-To: <20250819201334.545001-1-lyude@redhat.com> References: <20250819201334.545001-1-lyude@redhat.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 X-Scanned-By: MIMEDefang 3.0 on 10.30.177.12 Content-Type: text/plain; charset="utf-8" Just a drive-by fix I noticed: we don't actually document what the return value from cancel() does, so do that. Signed-off-by: Lyude Paul Reviewed-by: Andreas Hindborg Reviewed-by: Daniel Almeida --- V4: * Reword to "Returns `true` if the timer was running." rust/kernel/time/hrtimer.rs | 2 ++ 1 file changed, 2 insertions(+) diff --git a/rust/kernel/time/hrtimer.rs b/rust/kernel/time/hrtimer.rs index 144e3b57cc780..6bfc0223f4f57 100644 --- a/rust/kernel/time/hrtimer.rs +++ b/rust/kernel/time/hrtimer.rs @@ -324,6 +324,8 @@ pub unsafe trait HrTimerHandle { /// Note that the timer might be started by a concurrent start operati= on. If /// so, the timer might not be in the **stopped** state when this func= tion /// returns. + /// + /// Returns `true` if the timer was running. fn cancel(&mut self) -> bool; } =20 --=20 2.50.0