Skip to content

Commit a5394bf

Browse files
committed
Move version policy into separate document
1 parent 8446a11 commit a5394bf

File tree

2 files changed

+29
-15
lines changed

2 files changed

+29
-15
lines changed

README.md

Lines changed: 3 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -43,34 +43,22 @@ They are provided as early previews for community testing and preparation for th
4343
If you use an alpha release, we recommend you choose an exact version specification in your
4444
`Cargo.toml` like: `embedded-hal = "=1.0.0-alpha.2"`
4545

46-
See below for a way to implement both an `embedded-hal` `0.2.x` version and an `-alpha` version
47-
side by side in a HAL.
46+
See [this guide](docs/version-policy.md) for a way to implement both an `embedded-hal` `0.2.x`
47+
version and an `-alpha` version side by side in a HAL.
4848

4949
[#177]: https://github.com/rust-embedded/embedded-hal/issues/177
5050

5151
## Documents
5252

5353
- [How-to: add a new trait](docs/how-to-add-a-new-trait.md)
54+
- [Version policy](docs/version-policy.md)
5455

5556
## Implementations and drivers
5657
For a list of `embedded-hal` implementations and driver crates check the [awesome-embedded-rust]
5758
list.
5859

5960
[awesome-embedded-rust]: https://github.com/rust-embedded/awesome-embedded-rust#driver-crates
6061

61-
### Supporting different (alpha and non-alpha) HALs
62-
63-
[embedded-hal-compat](https://github.com/ryankurte/embedded-hal-compat) provides shims
64-
to support interoperability between the latest `0.2.x` and `1.0.0-alpha.N` HALs, allowing one to use
65-
incompatible HAL components (generally) without alteration.
66-
See the [docs](https://docs.rs/embedded-hal-compat/) for examples.
67-
68-
It is also possible for HAL implementations to support both the latest `0.2.x` and `1.0.0-alpha.N` versions
69-
side by side, for an example see [LPC8xx HAL](https://github.com/lpc-rs/lpc8xx-hal).
70-
71-
Note that `embedded-hal` `-alpha` versions are a moving target and _not guaranteed_ to be compatible.
72-
Because of this we only aim to support the latest `-alpha`.
73-
7462
## Minimum Supported Rust Version (MSRV)
7563

7664
This crate is guaranteed to compile on stable Rust 1.46 and up. It *might*

docs/version-policy.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Version policy
2+
3+
At the moment we are working towards a `1.0.0` release (see [#177]). During this process we will
4+
release alpha versions like `1.0.0-alpha.1` and `1.0.0-alpha.2`.
5+
Alpha releases are **not guaranteed** to be compatible with each other.
6+
They are provided as early previews for community testing and preparation for the final release.
7+
If you use an alpha release, we recommend you choose an exact version specification in your
8+
`Cargo.toml` like: `embedded-hal = "=1.0.0-alpha.2"`
9+
10+
See below for a way to implement both an `embedded-hal` `0.2.x` version and an `-alpha` version
11+
side by side in a HAL.
12+
13+
[#177]: https://github.com/rust-embedded/embedded-hal/issues/177
14+
15+
## Supporting different (alpha and non-alpha) HALs
16+
17+
[embedded-hal-compat](https://github.com/ryankurte/embedded-hal-compat) provides shims
18+
to support interoperability between the latest `0.2.x` and `1.0.0-alpha.N` HALs, allowing one to use
19+
incompatible HAL components (generally) without alteration.
20+
See the [docs](https://docs.rs/embedded-hal-compat/) for examples.
21+
22+
It is also possible for HAL implementations to support both the latest `0.2.x` and `1.0.0-alpha.N` versions
23+
side by side, for an example see [LPC8xx HAL](https://github.com/lpc-rs/lpc8xx-hal).
24+
25+
Note that `embedded-hal` `-alpha` versions are a moving target and _not guaranteed_ to be compatible.
26+
Because of this we only aim to support the latest `-alpha`.

0 commit comments

Comments
 (0)