Skip to content

Commit

Permalink
Merge #70
Browse files Browse the repository at this point in the history
70: Fix LineEvent timestamp doc r=eldruin a=mpi3d

Fix documentation on `LineEvent::timestamp()`.

According to the Linux documentation, the timestamp is `CLOCK_MONOTONIC` by default: [gpio.h#L286](https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/include/uapi/linux/gpio.h#n286).

Please see [#68 comment](#68 (comment)).

Co-authored-by: Matthieu CHARETTE <matthieu.charette@gmail.com>
  • Loading branch information
bors[bot] and mpi3d committed Jun 5, 2023
2 parents cff902f + 4deea43 commit e636a82
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 2 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

- MSRV is now 1.59.0.

## [v0.5.1] - 2021-11-22

Expand Down
6 changes: 4 additions & 2 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -920,8 +920,10 @@ impl LineEvent {
/// in an interrupt handler so it should be very accurate.
///
/// The nanosecond timestamp value should are captured
/// using the `CLOCK_REALTIME` offsets in the kernel and
/// should be compared against `CLOCK_REALTIME` values.
/// using the `CLOCK_MONOTONIC` offsets in the kernel and
/// should be compared against `CLOCK_MONOTONIC` values.
/// Note that kernel versions prior to 5.7 used
/// `CLOCK_REALTIME` offsets instead.
pub fn timestamp(&self) -> u64 {
self.0.timestamp
}
Expand Down

0 comments on commit e636a82

Please sign in to comment.