Skip to content

Commit

Permalink
doc: update changelog
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
yvt committed Mar 20, 2022
1 parent 330a28d commit 1ded06e
Show file tree
Hide file tree
Showing 8 changed files with 9 additions and 1 deletion.
3 changes: 2 additions & 1 deletion src/r3/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.

## [0.2.0] - 2022-03-15

**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.
**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.

### Changed

Expand All @@ -29,6 +29,7 @@ While much of the application-level API has retained its general shape, there ar
- The `chrono` Cargo feature was renamed to `chrono_0p4`.
- `r3::sync` is now gated by `cfg(feature = "sync")`.
- `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.
- **Breaking (semver-exempt):** Change the target compiler version to `nightly-2022-03-10`

### Added

Expand Down
1 change: 1 addition & 0 deletions src/r3_port_arm/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
### Changed

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

### Fixed

Expand Down
1 change: 1 addition & 0 deletions src/r3_port_arm_m/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
### Changed

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

### Fixed

Expand Down
1 change: 1 addition & 0 deletions src/r3_port_riscv/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.

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

### Added

Expand Down
1 change: 1 addition & 0 deletions src/r3_port_std/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
### Changed

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

### Added

Expand Down
1 change: 1 addition & 0 deletions src/r3_portkit/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.

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

## [0.1.3] - 2021-10-29

Expand Down
1 change: 1 addition & 0 deletions src/r3_support_rp2040/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
### Changed

- **Breaking:** Adjusted for the new design of R3-OS (separation between interface and implementation). Supports `r3_port_arm_m ^0.3`.
- **Breaking (semver-exempt):** Change the target compiler version to `nightly-2022-03-10`
- [`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`.

## [0.1.1] - 2021-10-29
Expand Down
1 change: 1 addition & 0 deletions src/r3_support_rza1/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
### Changed

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

## [0.1.2] - 2021-10-29

Expand Down

0 comments on commit 1ded06e

Please sign in to comment.