diff options
| author | Lyude Paul <lyude@redhat.com> | 2025-08-21 15:32:41 -0400 |
|---|---|---|
| committer | Andreas Hindborg <a.hindborg@kernel.org> | 2025-09-04 16:54:39 +0200 |
| commit | a984da24e7ac411c95bab7b6c127bae4927f9d03 (patch) | |
| tree | 2c3341c7802030a974fbe4b6c7ac0bd652d7d704 /rust/kernel | |
| parent | b320789d6883cc00ac78ce83bccbfe7ed58afcf0 (diff) | |
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>
Diffstat (limited to 'rust/kernel')
| -rw-r--r-- | rust/kernel/time/hrtimer.rs | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/rust/kernel/time/hrtimer.rs b/rust/kernel/time/hrtimer.rs index 144e3b57cc78..6bfc0223f4f5 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 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; } |