docs(rtc): Mention in the time_since_boot() that the timer is reset only on a power-on-reset

JurajSadel · JurajSadel · commit a9b39485c00b · 2025-12-08T13:27:17.000+01:00
diff --git a/esp-hal/src/rtc_cntl/mod.rs b/esp-hal/src/rtc_cntl/mod.rs
@@ -288,6 +288,9 @@ impl<'d> Rtc<'d> {
     }
 
     /// Get the time since boot.
+    ///
+    /// It should be noted that any reset or sleep, other than a power-up reset, will not stop or
+    /// reset the RTC timer.
     pub fn time_since_boot(&self) -> Duration {
         Duration::from_micros(
             self.time_since_boot_raw() * 1_000_000

Original file line number	Diff line number	Diff line change
`@@ -288,6 +288,9 @@ impl<'d> Rtc<'d> {`
`288`	`288`	`}`
`289`	`289`
`290`	`290`	`/// Get the time since boot.`
	`291`	`+ ///`
	`292`	`+ /// It should be noted that any reset or sleep, other than a power-up reset, will not stop or`
	`293`	`+ /// reset the RTC timer.`
`291`	`294`	`pub fn time_since_boot(&self) -> Duration {`
`292`	`295`	`Duration::from_micros(`
`293`	`296`	`self.time_since_boot_raw() * 1_000_000`