Merge #70

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 <[email protected]>

Author: bors[bot]

.github/bors.toml

@@ -17,7 +17,7 @@ status = [
     "build (stable, x86_64-unknown-linux-gnu)",
     "build (stable, x86_64-unknown-linux-musl)",
 
-    "build (1.46.0, x86_64-unknown-linux-gnu)",
+    "build (1.56.0, x86_64-unknown-linux-gnu)",
 
     "checks"
 ]

.github/workflows/ci.yml

@@ -33,7 +33,7 @@ jobs:
 
         include:
           # MSRV
-          - rust: 1.46.0
+          - rust: 1.56.0
             TARGET: x86_64-unknown-linux-gnu
 
           # Test nightly but don't fail
@@ -107,7 +107,7 @@ jobs:
       - uses: actions-rs/toolchain@v1
         with:
           profile: minimal
-          toolchain: 1.46.0
+          toolchain: 1.56.0
           components: clippy
 
       - uses: actions-rs/clippy-check@v1

CHANGELOG.md

@@ -8,6 +8,7 @@ Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
 
+- MSRV is now 1.56.0.
 
 ## [v0.5.1] - 2021-11-22
 

README.md

@@ -206,7 +206,7 @@ to be considered reliable.
 
 ## Minimum Supported Rust Version (MSRV)
 
-This crate is guaranteed to compile on stable Rust 1.46.0 and up. It *might*
+This crate is guaranteed to compile on stable Rust 1.56.0 and up. It *might*
 compile with older versions but that may change in any new patch release.
 
 ## License

src/lib.rs

@@ -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
     }