Skip to content

Commit a984da2

Browse files
LyudeAndreas Hindborg
authored andcommitted
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: Lyude Paul <lyude@redhat.com> Reviewed-by: Andreas Hindborg <a.hindborg@kernel.org> Reviewed-by: Daniel Almeida <daniel.almeida@collabora.com> Link: https://lore.kernel.org/r/20250821193259.964504-2-lyude@redhat.com Signed-off-by: Andreas Hindborg <a.hindborg@kernel.org>
1 parent b320789 commit a984da2

1 file changed

Lines changed: 2 additions & 0 deletions

File tree

rust/kernel/time/hrtimer.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -324,6 +324,8 @@ pub unsafe trait HrTimerHandle {
324324
/// Note that the timer might be started by a concurrent start operation. If
325325
/// so, the timer might not be in the **stopped** state when this function
326326
/// returns.
327+
///
328+
/// Returns `true` if the timer was running.
327329
fn cancel(&mut self) -> bool;
328330
}
329331

0 commit comments

Comments
 (0)