linux-kernel - Re: [PATCH v2 1/8] rust: hrtimer: Document the return value for HrTimerHandle::cancel()

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite for Android: free password hash cracker in your pocket

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <87r01jmg01.fsf@kernel.org>
Date: Wed, 23 Apr 2025 10:36:14 +0200
From: Andreas Hindborg <a.hindborg@...nel.org>
To: Lyude Paul <lyude@...hat.com>
Cc: rust-for-linux@...r.kernel.org,  linux-kernel@...r.kernel.org,  Boqun
 Feng <boqun.feng@...il.com>,  FUJITA Tomonori <fujita.tomonori@...il.com>,
  Frederic Weisbecker <frederic@...nel.org>,  Thomas Gleixner
 <tglx@...utronix.de>,  Anna-Maria Behnsen <anna-maria@...utronix.de>,
  John Stultz <jstultz@...gle.com>,  Stephen Boyd <sboyd@...nel.org>,
  Miguel Ojeda <ojeda@...nel.org>,  Alex Gaynor <alex.gaynor@...il.com>,
  Gary Guo <gary@...yguo.net>,  Björn Roy Baron
 <bjorn3_gh@...tonmail.com>,
  Benno Lossin <benno.lossin@...ton.me>,  Alice Ryhl
 <aliceryhl@...gle.com>,  Trevor Gross <tmgross@...ch.edu>,  Danilo
 Krummrich <dakr@...nel.org>
Subject: Re: [PATCH v2 1/8] rust: hrtimer: Document the return value for
 HrTimerHandle::cancel()

Lyude Paul <lyude@...hat.com> writes:

> 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 <lyude@...hat.com>
> ---
>  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 27243eaaf8ed7..bfe0e25f5abd0 100644
> --- a/rust/kernel/time/hrtimer.rs
> +++ b/rust/kernel/time/hrtimer.rs
> @@ -304,6 +304,8 @@ pub unsafe trait HrTimerHandle {
>      /// Note that the timer might be started by a concurrent start operation. If
>      /// so, the timer might not be in the **stopped** state when this function
>      /// returns.
> +    ///
> +    /// Returns whether or not the timer was running.

How about:

  Returns true if the timer was running.

?


Best regards,
Andreas Hindborg