From nobody Fri Oct 10 13:59:19 2025 Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.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 58729247296 for ; Fri, 13 Jun 2025 23:28:13 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=170.10.133.124 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1749857294; cv=none; b=eDRvZNawOU2MPmSbUlC6PdJTmYKjsGyw98ZrsSRFs0zbGpgXeleDvPMZLzmAj8wnbwDC6+asCjK5sw103RV7hSnpmjmkB9rlmtuiONc++tYp0BPEgUhlVdh2q9j82a4tv4x5nMQW6wdv8poBZilEdiE+a4tgPJ3qmw8hSpagfJ8= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1749857294; c=relaxed/simple; bh=6xwBQ8XFSwXpWFSAxeZ7Jy8x94+usvMvfj6eVa6OR6M=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=KFPJYfjheW7f99HDGalqDTKDeTfr7Zwl7u7ZeDAYpPWRFgVe5IhuPf3pEkb9qSpMjJbwH2lH2ine0Qf9rOjEbUGhAKf6mcROafgnvHpfc2UZpC2YgYRP3Xrq+ODx9HBeKokt/xvZgrZbuBxS3aTVx7nEGyCz6B5cjkAsAjeUWQk= 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=OjEjPeQd; arc=none smtp.client-ip=170.10.133.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="OjEjPeQd" DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1749857292; 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=Sd5OvAnSvV+D6OhpTlfHjUIhs7V1jSP69SJuBda5Kmc=; b=OjEjPeQdX3s7iPkwdOm74a90Zd4kGva6jAG09fAOZvRBoRhIQ2wrLhrgVzjt1/3+6OLg2v YRzwx0gsAFdPJh30WrNvnP1uUhkDste7coCFF+eybgBrB55m22uW7zdvyJeLKMcWZlKhTt p2Cz/FwnJ2PiXcRNjbGzrK6finJOxyc= Received: from mx-prod-mc-05.mail-002.prod.us-west-2.aws.redhat.com (ec2-54-186-198-63.us-west-2.compute.amazonaws.com [54.186.198.63]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-614-sb4txEUMNx2eJP1DD2mfXQ-1; Fri, 13 Jun 2025 19:28:08 -0400 X-MC-Unique: sb4txEUMNx2eJP1DD2mfXQ-1 X-Mimecast-MFC-AGG-ID: sb4txEUMNx2eJP1DD2mfXQ_1749857286 Received: from mx-prod-int-06.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-06.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.93]) (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-05.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id EA41F1956089; Fri, 13 Jun 2025 23:28:05 +0000 (UTC) Received: from chopper.redhat.com (unknown [10.22.64.52]) by mx-prod-int-06.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id 7E9EE180045B; Fri, 13 Jun 2025 23:28:01 +0000 (UTC) From: Lyude Paul To: rust-for-linux@vger.kernel.org, Andreas Hindborg , linux-kernel@vger.kernel.org Cc: Boqun Feng , FUJITA Tomonori , Frederic Weisbecker , Thomas Gleixner , 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 v5 1/7] rust: hrtimer: Document the return value for HrTimerHandle::cancel() Date: Fri, 13 Jun 2025 19:22:22 -0400 Message-ID: <20250613232754.451450-2-lyude@redhat.com> In-Reply-To: <20250613232754.451450-1-lyude@redhat.com> References: <20250613232754.451450-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.4.1 on 10.30.177.93 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 --- V4: * Reword to "Returns `true` if the timer was running." Signed-off-by: Lyude Paul --- 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 3980a7c5f7dbe..294f257ef5c5a 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.49.0