Skip to content

Commit 5055422

Browse files
authored
Merge pull request #619 from Dirbaio/remove-nightly-checks
Remove nightly checks.
2 parents d31dfde + f593acb commit 5055422

File tree

16 files changed

+35
-134
lines changed

16 files changed

+35
-134
lines changed

.github/workflows/clippy.yml

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,7 @@ jobs:
1111
runs-on: ubuntu-latest
1212
steps:
1313
- uses: actions/checkout@v4
14-
- uses: dtolnay/rust-toolchain@master
14+
- uses: dtolnay/rust-toolchain@stable
1515
with:
16-
# embedded-hal-async needs nightly.
17-
# Use a pinned version to avoid spontaneous breakages (new clippy lints are added often)
18-
toolchain: nightly-2023-10-14
1916
components: clippy
2017
- run: cargo clippy --all-features -- --deny=warnings

.github/workflows/rustdoc.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,6 @@ jobs:
1313
- uses: actions/checkout@v4
1414
- uses: dtolnay/rust-toolchain@master
1515
with:
16-
toolchain: nightly-2023-10-14
16+
toolchain: nightly-2024-07-26
1717
# tokio/net required to workaround https://github.com/tokio-rs/tokio/issues/6165
1818
- run: RUSTDOCFLAGS="--deny=warnings --cfg=docsrs" cargo doc --all-features --features tokio/net

.github/workflows/rustfmt.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,7 @@ jobs:
1212
runs-on: ubuntu-latest
1313
steps:
1414
- uses: actions/checkout@v4
15-
- uses: dtolnay/rust-toolchain@master
15+
- uses: dtolnay/rust-toolchain@stable
1616
with:
17-
toolchain: nightly
1817
components: rustfmt
1918
- run: cargo fmt --check

embedded-hal-async/build.rs

Lines changed: 0 additions & 18 deletions
This file was deleted.

embedded-hal-async/src/lib.rs

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
11
#![doc = include_str!("../README.md")]
22
#![warn(missing_docs)]
33
#![no_std]
4-
// disable warning for already-stabilized features.
5-
// Needed to pass CI, because we deny warnings.
6-
// We don't immediately remove them to not immediately break older nightlies.
7-
// When all features are stable, we'll remove them.
8-
#![cfg_attr(nightly, allow(stable_features, unknown_lints))]
9-
#![cfg_attr(nightly, feature(async_fn_in_trait, impl_trait_projections))]
104
#![allow(async_fn_in_trait)]
115

126
pub mod delay;

embedded-hal-bus/build.rs

Lines changed: 0 additions & 18 deletions
This file was deleted.

embedded-hal-bus/src/lib.rs

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,6 @@
22
#![warn(missing_docs)]
33
#![cfg_attr(not(feature = "std"), no_std)]
44
#![cfg_attr(docsrs, feature(doc_cfg))]
5-
// disable warning for already-stabilized features.
6-
// Needed to pass CI, because we deny warnings.
7-
// We don't immediately remove them to not immediately break older nightlies.
8-
// When all features are stable, we'll remove them.
9-
#![cfg_attr(all(feature = "async", nightly), allow(stable_features))]
10-
#![cfg_attr(
11-
all(feature = "async", nightly),
12-
feature(async_fn_in_trait, impl_trait_projections)
13-
)]
145

156
// needed to prevent defmt macros from breaking, since they emit code that does `defmt::blahblah`.
167
#[cfg(feature = "defmt-03")]

embedded-hal-nb/src/spi.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,13 @@ pub use embedded_hal::spi::{
1313
/// - Due to how full duplex SPI works each `read` call must be preceded by a `write` call.
1414
///
1515
/// - `read` calls only return the data received with the last `write` call.
16-
/// Previously received data is discarded
16+
/// Previously received data is discarded
1717
///
1818
/// - Data is only guaranteed to be clocked out when the `read` call succeeds.
19-
/// The slave select line shouldn't be released before that.
19+
/// The slave select line shouldn't be released before that.
2020
///
2121
/// - Some SPIs can work with 8-bit *and* 16-bit words. You can overload this trait with different
22-
/// `Word` types to allow operation in both modes.
22+
/// `Word` types to allow operation in both modes.
2323
pub trait FullDuplex<Word: Copy = u8>: ErrorType {
2424
/// Reads the word stored in the shift register
2525
///

embedded-hal/README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -37,37 +37,37 @@ or a console to operate either on hardware serial ports or on virtual ones like
3737
The HAL
3838

3939
- Must *erase* device specific details. Neither register, register blocks, nor magic values should
40-
appear in the API.
40+
appear in the API.
4141

4242
- Must be generic *within* a device and *across* devices. The API to use a serial interface must
43-
be the same regardless of whether the implementation uses the USART1 or UART4 peripheral of a
44-
device or the UART0 peripheral of another device.
43+
be the same regardless of whether the implementation uses the USART1 or UART4 peripheral of a
44+
device or the UART0 peripheral of another device.
4545

4646
- Where possible must *not* be tied to a specific asynchronous model. The API should be usable
47-
in blocking mode, with the `futures` model, with an async/await model or with a callback model.
48-
(cf. the [`nb`](https://docs.rs/nb) crate)
47+
in blocking mode, with the `futures` model, with an async/await model or with a callback model.
48+
(cf. the [`nb`](https://docs.rs/nb) crate)
4949

5050
- Must be minimal, and thus easy to implement and zero cost, yet highly composable. People that
51-
want higher level abstraction should *prefer to use this HAL* rather than *re-implement*
52-
register manipulation code.
51+
want higher level abstraction should *prefer to use this HAL* rather than *re-implement*
52+
register manipulation code.
5353

5454
- Serve as a foundation for building an ecosystem of platform-agnostic drivers. Here driver
55-
means a library crate that lets a target platform interface an external device like a digital
56-
sensor or a wireless transceiver. The advantage of this system is that by writing the driver as
57-
a generic library on top of `embedded-hal` driver authors can support any number of target
58-
platforms (e.g. Cortex-M microcontrollers, AVR microcontrollers, embedded Linux, etc.). The
59-
advantage for application developers is that by adopting `embedded-hal` they can unlock all
60-
these drivers for their platform.
55+
means a library crate that lets a target platform interface an external device like a digital
56+
sensor or a wireless transceiver. The advantage of this system is that by writing the driver as
57+
a generic library on top of `embedded-hal` driver authors can support any number of target
58+
platforms (e.g. Cortex-M microcontrollers, AVR microcontrollers, embedded Linux, etc.). The
59+
advantage for application developers is that by adopting `embedded-hal` they can unlock all
60+
these drivers for their platform.
6161

6262
- Trait methods must be fallible so that they can be used in any possible situation.
63-
Nevertheless, HAL implementations can additionally provide infallible versions of the same methods
64-
if they can never fail in their platform. This way, generic code can use the fallible abstractions
65-
provided here but platform-specific code can avoid fallibility-related boilerplate if possible.
63+
Nevertheless, HAL implementations can additionally provide infallible versions of the same methods
64+
if they can never fail in their platform. This way, generic code can use the fallible abstractions
65+
provided here but platform-specific code can avoid fallibility-related boilerplate if possible.
6666

6767
## Out of scope
6868

6969
- Initialization and configuration stuff like "ensure this serial interface and that SPI
70-
interface are not using the same pins". The HAL will focus on *doing I/O*.
70+
interface are not using the same pins". The HAL will focus on *doing I/O*.
7171

7272
## Platform agnostic drivers
7373

embedded-io-adapters/build.rs

Lines changed: 0 additions & 18 deletions
This file was deleted.

0 commit comments

Comments
 (0)