Skip to content

Commit 1ded06e

Browse files
committed
doc: update changelog
Adds missing entries regarding the target compiler version change that occurred in `r3 0.2.0`, etc. Rewords the description of the package reorganization in `r3 0.2.0` to be clearer.
1 parent 330a28d commit 1ded06e

File tree

8 files changed

+9
-1
lines changed

8 files changed

+9
-1
lines changed

src/r3/CHANGELOG.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
1616

1717
## [0.2.0] - 2022-03-15
1818

19-
**The design has been wholly revamped!** `r3_core ^0.1` defines the interface between an application and a kernel implementation. `r3` re-exports most of `r3_core` and provides additional items. The current kernel implementation has been moved to `r3_kernel 0.1.0`. Different kernel implementations that use more exotic architectures (such as interrupt-driven multi-threading) or are built on top on existing RTOSes may be added in the future.
19+
**The overall design has been revamped!** The original kernel implementation has been moved to a separate crate `r3_kernel`. `r3_core` harbors the interface definition for a kernel implementation, and `r3` provides additional useful items, such as a mutex-backed cell type (`StaticMutex`). Different kernel implementations that use more exotic architectures (such as interrupt-driven multi-threading) or are built on top on existing RTOSes may be added in the future.
2020

2121
### Changed
2222

@@ -29,6 +29,7 @@ While much of the application-level API has retained its general shape, there ar
2929
- The `chrono` Cargo feature was renamed to `chrono_0p4`.
3030
- `r3::sync` is now gated by `cfg(feature = "sync")`.
3131
- `r3::sync::{Mutex, RecursiveMutex}` is now backed by bindings (`Bind`). The default value is now `<T as Default>::default()` instead of `<T as Init>::INIT`. Additional options are available, which means you no longer have to implement `Init` just to put a custom type in `Mutex`, and that each `Mutex` can have a distinct initial value.
32+
- **Breaking (semver-exempt):** Change the target compiler version to `nightly-2022-03-10`
3233

3334
### Added
3435

src/r3_port_arm/CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
1818
### Changed
1919

2020
- **Breaking:** Adjusted for the new design of R3-OS (separation between interface and implementation). Supports `r3_kernel ^0.1`.
21+
- **Breaking (semver-exempt):** Change the target compiler version to `nightly-2022-03-10`
2122

2223
### Fixed
2324

src/r3_port_arm_m/CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
1818
### Changed
1919

2020
- **Breaking:** Adjusted for the new design of R3-OS (separation between interface and implementation). Supports `r3_kernel ^0.1`.
21+
- **Breaking (semver-exempt):** Change the target compiler version to `nightly-2022-03-10`
2122

2223
### Fixed
2324

src/r3_port_riscv/CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
2020

2121
- **Breaking:** Adjusted for the new design of R3-OS (separation between interface and implementation). Supports `r3_kernel ^0.1`.
2222
- Rename `use_timer!``use_mtime!`, `TimerOptions``MtimeOptions`
23+
- **Breaking (semver-exempt):** Change the target compiler version to `nightly-2022-03-10`
2324

2425
### Added
2526

src/r3_port_std/CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
1818
### Changed
1919

2020
- **Breaking:** Adjusted for the new design of R3-OS (separation between interface and implementation). Supports `r3_kernel ^0.1`.
21+
- **Breaking (semver-exempt):** Change the target compiler version to `nightly-2022-03-10`
2122

2223
### Added
2324

src/r3_portkit/CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
2020

2121
- **Breaking:** Adjusted for the new design of R3-OS (separation between interface and implementation). Supports `r3_kernel ^0.1`.
2222
- **Breaking:** `sym_static!` was redesigned to address multiple issues.
23+
- **Breaking (semver-exempt):** Change the target compiler version to `nightly-2022-03-10`
2324

2425
## [0.1.3] - 2021-10-29
2526

src/r3_support_rp2040/CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
1818
### Changed
1919

2020
- **Breaking:** Adjusted for the new design of R3-OS (separation between interface and implementation). Supports `r3_port_arm_m ^0.3`.
21+
- **Breaking (semver-exempt):** Change the target compiler version to `nightly-2022-03-10`
2122
- [`rp2040-pac ^0.3`](https://crates.io/crates/rp2040-pac) replaces [`rp2040 ^0.1`](https://crates.io/crates/rp2040) as the RP2040 peripheral access crate used by `r3_support_rp2040`.
2223

2324
## [0.1.1] - 2021-10-29

src/r3_support_rza1/CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
1818
### Changed
1919

2020
- **Breaking:** Adjusted for the new design of R3-OS (separation between interface and implementation). Supports `r3_port_arm ^0.2`.
21+
- **Breaking (semver-exempt):** Change the target compiler version to `nightly-2022-03-10`
2122

2223
## [0.1.2] - 2021-10-29
2324

0 commit comments

Comments
 (0)