Commit a984da24 authored by Lyude Paul's avatar Lyude Paul Committed by Andreas Hindborg
Browse files

rust: hrtimer: Document the return value for HrTimerHandle::cancel() 



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: default avatarLyude Paul <lyude@redhat.com>
Reviewed-by: default avatarAndreas Hindborg <a.hindborg@kernel.org>
Reviewed-by: default avatarDaniel Almeida <daniel.almeida@collabora.com>
Link: https://lore.kernel.org/r/20250821193259.964504-2-lyude@redhat.com


Signed-off-by: default avatarAndreas Hindborg <a.hindborg@kernel.org>
parent b320789d

rust/kernel/time/hrtimer.rs

+2 −0
Original line number Diff line number Diff line
@@ -324,6 +324,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 `true` if the timer was running.

    fn cancel(&mut self) -> bool;

}