Skip to content

Commit 0935051

Browse files
kyp44Dan WhitmanAfoHT
authored
ATSAMD RTC monotonic referral in documentation (#1014)
* rtic-monotonics: Adds a section to the module documentation about ATSAMD chip monotonics provided in the `atsamd-hal` crate * rtic-monotonics: Adds a section to README listing the supported microcontroller platforms. * rtic-sync: Fix clippy complaints error: the following explicit lifetimes could be elided: 'a --> rtic-sync/src/signal.rs:113:6 | 113 | impl<'a, T: Copy> SignalReader<'a, T> { | ^^ ^^ | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#needless_lifetimes = note: `-D clippy::needless-lifetimes` implied by `-D warnings` = help: to override `-D warnings` add `#[allow(clippy::needless_lifetimes)]` help: elide the lifetimes | 113 - impl<'a, T: Copy> SignalReader<'a, T> { 113 + impl<T: Copy> SignalReader<'_, T> { * xtask: Clippy fix warning warning: elided lifetime has a name --> xtask/src/cargo_command.rs:427:14 | 420 | fn build_args<'i, T: Iterator<Item = &'i str>>( | -- lifetime `'i` declared here ... 427 | ) -> Vec<&str> { | ^ this elided lifetime gets resolved as `'i` | = note: `#[warn(elided_named_lifetimes)]` on by default --------- Co-authored-by: Dan Whitman <[email protected]> Co-authored-by: Henrik Tjäder <[email protected]>
1 parent 26b1ab0 commit 0935051

File tree

4 files changed

+17
-2
lines changed

4 files changed

+17
-2
lines changed

rtic-monotonics/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,16 @@ For RTIC v1 see [`rtic-monotonic`](https://github.com/rtic-rs/rtic-monotonic)
1515

1616
### [Changelog `rtic-monotonics`](https://github.com/rtic-rs/rtic/blob/master/rtic-monotonics/CHANGELOG.md)
1717

18+
## Supported Platforms
19+
20+
The following microcontroller families feature efficient monotonics using peripherals.
21+
Refer to the [crate documentation](https://docs.rs/rtic-monotonics) for more details.
22+
23+
- RP2040
24+
- i.MX RT
25+
- nRF
26+
- ATSAMD
27+
1828
## License
1929

2030
Licensed under either of

rtic-monotonics/src/lib.rs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,11 @@
2525
//! tag, describing what parts _do_ support that monotonic. Monotonics without an
2626
//! `Available on crate features X only` tag are available on any `nrf52*` feature.
2727
//!
28+
//! # ATSAMD
29+
//! Monotonics for the ATSAMD family of parts using the real time clock (RTC) are provided in the
30+
//! [`atsamd-hal`](https://docs.rs/atsamd-hal/latest/atsamd_hal/rtc/rtic/index.html)
31+
//! crate with the `rtic` feature enabled.
32+
//!
2833
//! # Priority of interrupt handlers
2934
//!
3035
//! The priority of timer interrupts are based on `RTIC_ASYNC_MAX_LOGICAL_PRIO` generated by RTIC.

rtic-sync/src/signal.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ where
110110
}
111111
}
112112

113-
impl<'a, T: Copy> SignalReader<'a, T> {
113+
impl<T: Copy> SignalReader<'_, T> {
114114
/// Immediately read and evict the latest value stored in the Signal.
115115
fn take(&mut self) -> Store<T> {
116116
critical_section::with(|_| {

xtask/src/cargo_command.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -424,7 +424,7 @@ impl<'a> CargoCommand<'a> {
424424
features: &'i Option<String>,
425425
mode: Option<&'i BuildMode>,
426426
extra: T,
427-
) -> Vec<&str> {
427+
) -> Vec<&'i str> {
428428
let mut args: Vec<&str> = Vec::new();
429429

430430
if nightly {

0 commit comments

Comments
 (0)