Skip to content

Commit 5c28299

Browse files
yvtyvt
committed
doc: split CHANGELOG.md for each published package
As nightmare-ish as it seems, this is probably the only sane way.
1 parent c7b80d7 commit 5c28299

File tree

9 files changed

+225
-43
lines changed

9 files changed

+225
-43
lines changed

‎CHANGELOG.md

Lines changed: 9 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,16 @@
11
# Changelog
22

3-
All notable changes to this project will be documented in this file.
3+
See [the `r3` package's `CHANGELOG.md`](./src/r3/CHANGELOG.md).
44

5-
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
6-
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
5+
---
76

8-
## [Unreleased]
7+
R3 is distributed as a [monorepo][] (poorly) mimicing the style of [lerna][]. This was inspired by several other large open-source projects distributed this way, including [React][], [Gatsby][], etc.
98

10-
### Changed
9+
This means that our `CHANGELOG.md` files are distributed alongside the package itself in the `src` directory.
1110

12-
- **Breaking:** Change the target compiler version to `nightly-2021-10-18`
13-
- Replace `register 1` with `tock-registers 0.7` because `tock-registers 0.6`, which is used by `register`, isn't compatible with the current target compiler.
14-
- Upgrade `r0` to `^1.0.0`
15-
- Upgrade `tokenlock` to `0.3.4`
16-
- Support `cortex-m` `^0.6` *and* `^0.7`
17-
- Support `cortex-m-rt` `^0.6` *and* `^0.7`
18-
- Support `riscv` `^0.5`, `^0.6`, *and* `^0.7`
19-
- Using the new version of `tokenlock`, some atomics-based hacks were removed. This might marginally improve the runtime performance as the compiler is given more leeway to optimize memory accesses.
20-
- **Breaking:** The `cortex-m-rt` binding has been separated to `r3_port_arm_m::use_rt!`.
21-
- `r3_port_arm_m` now steals `cortex_m::Peripherals` on boot. This is useful in multi-core systems.
11+
For example, the package `r3_portkit` has a CHANGELOG.md in [`src/r3_portkit/CHANGELOG.md`](./src/r3_portkit/CHANGELOG.md). If you'd like to check out others, check out the [`src`](./src) directory in the root of the repo.
2212

23-
<!-- TODO: It doesn't seem like a good idea to congregate the changes of all packages, each of which has its own pace, into a single changelog file -->
24-
25-
### Fixed
26-
27-
- The debug printing of `Mutex` and `RecursiveMutex` in an invalid context now produces a message that makes sense.
28-
- Rewrite invalid `#[naked]` functions in valid forms
29-
30-
## [0.1.1] - 2020-12-20
31-
32-
### Added
33-
34-
- `r3_port_std`'s POSIX backend now supports AArch64.
35-
36-
### Changed
37-
38-
- Change the target compiler version to `nightly-2020-11-25`
39-
40-
### Fixed
41-
42-
- Wrap const generic arguments in braces, fixing builds on the latest compiler version
43-
- Remove `#[naked]` when inlining is prerequisite for correctness; functions with `#[naked]` are no longer eligible for inlining as of [rust-lang/rust#79192](https://github.com/rust-lang/rust/pull/79192).
44-
45-
## 0.1.0 - 2020-11-03
46-
47-
- Initial release.
48-
49-
[Unreleased]: https://github.com/yvt/r3/compare/0.1.1...HEAD
50-
[0.1.1]: https://github.com/yvt/r3/compare/0.1.0...0.1.1
13+
[monorepo]: https://en.wikipedia.org/wiki/Monorepo
14+
[lerna]: https://github.com/lerna/lerna
15+
[react]: https://github.com/facebook/react/tree/master/packages
16+
[Gatsby]: https://github.com/gatsbyjs/gatsby

‎src/r3/CHANGELOG.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
6+
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
7+
8+
## [Unreleased]
9+
10+
### Changed
11+
12+
- **Breaking (semver-exempt):** Change the target compiler version to `nightly-2021-10-18`
13+
- Upgrade `tokenlock` to `0.3.4`
14+
- Using the new version of `tokenlock`, some atomics-based hacks were removed. This might marginally improve the runtime performance as the compiler is given more leeway to optimize memory accesses.
15+
16+
### Fixed
17+
18+
- The debug printing of `Mutex` and `RecursiveMutex` in an invalid context now produces a message that makes sense.
19+
20+
## [0.1.1] - 2020-12-20
21+
22+
### Changed
23+
24+
- **Breaking (semver-exempt):** Change the target compiler version to `nightly-2020-11-25`
25+
26+
### Fixed
27+
28+
- Wrap const generic arguments in braces, fixing builds on the latest compiler version
29+
30+
## 0.1.0 - 2020-11-03
31+
32+
Initial release.
33+
34+
[Unreleased]: https://github.com/yvt/r3/compare/[email protected]
35+
[0.1.1]: https://github.com/yvt/r3/compare/[email protected]@0.1.1

‎src/r3_port_arm/CHANGELOG.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
6+
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
7+
8+
## [Unreleased]
9+
10+
### Changed
11+
12+
- **Breaking (semver-exempt):** Change the target compiler version to `nightly-2021-10-18`
13+
- Upgrade `r0` to `^1.0.0`
14+
- Replace `register 1` with `tock-registers 0.7` because `tock-registers 0.6`, which is used by `register`, isn't compatible with the current target compiler.
15+
16+
### Fixed
17+
18+
- Remove `#[naked]` when inlining is prerequisite for correctness; functions with `#[naked]` are no longer eligible for inlining as of [rust-lang/rust#79192](https://github.com/rust-lang/rust/pull/79192).
19+
- Rewrite invalid `#[naked]` functions in valid forms
20+
21+
## 0.1.0 - 2020-11-03
22+
23+
Initial release.
24+
25+
[Unreleased]: https://github.com/yvt/r3/compare/[email protected]

‎src/r3_port_arm_m/CHANGELOG.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
6+
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
7+
8+
## [Unreleased]
9+
10+
### Changed
11+
12+
- **Breaking (semver-exempt):** Change the target compiler version to `nightly-2021-10-18`
13+
- **Breaking:** The `cortex-m-rt` binding has been separated to `r3_port_arm_m::use_rt!`.
14+
- Support `cortex-m` `^0.6` *and* `^0.7`
15+
- Support `cortex-m-rt` `^0.6` *and* `^0.7`
16+
- `r3_port_arm_m` now steals `cortex_m::Peripherals` on boot. This is useful in multi-core systems.
17+
18+
## [0.1.1] - 2020-12-20
19+
20+
### Changed
21+
22+
- **Breaking (semver-exempt):** Change the target compiler version to `nightly-2020-11-25`
23+
24+
## 0.1.0 - 2020-11-03
25+
26+
Initial release.
27+
28+
[Unreleased]: https://github.com/yvt/r3/compare/[email protected]
29+
[0.1.1]: https://github.com/yvt/r3/compare/[email protected][email protected]
30+

‎src/r3_port_riscv/CHANGELOG.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
6+
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
7+
8+
## [Unreleased]
9+
10+
### Changed
11+
12+
- **Breaking (semver-exempt):** Change the target compiler version to `nightly-2021-10-18`
13+
- Support `riscv` `^0.5`, `^0.6`, *and* `^0.7`
14+
- Replace `register 1` with `tock-registers 0.7` because `tock-registers 0.6`, which is used by `register`, isn't compatible with the current target compiler.
15+
16+
### Fixed
17+
18+
- Rewrite invalid `#[naked]` functions in valid forms
19+
20+
## [0.1.1] - 2020-12-20
21+
22+
### Changed
23+
24+
- **Breaking (semver-exempt):** Change the target compiler version to `nightly-2020-11-25`
25+
26+
### Fixed
27+
28+
- Remove `#[naked]` when inlining is prerequisite for correctness; functions with `#[naked]` are no longer eligible for inlining as of [rust-lang/rust#79192](https://github.com/rust-lang/rust/pull/79192).
29+
30+
## 0.1.0 - 2020-11-03
31+
32+
Initial release.
33+
34+
[Unreleased]: https://github.com/yvt/r3/compare/[email protected]
35+
[0.1.1]: https://github.com/yvt/r3/compare/[email protected][email protected]
36+

‎src/r3_port_std/CHANGELOG.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
6+
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
7+
8+
## [Unreleased]
9+
10+
### Changed
11+
12+
- **Breaking (semver-exempt):** Change the target compiler version to `nightly-2021-10-18`
13+
14+
## [0.1.1] - 2020-12-20
15+
16+
### Added
17+
18+
- The POSIX backend now supports AArch64.
19+
20+
21+
## 0.1.0 - 2020-11-03
22+
23+
Initial release.
24+
25+
[Unreleased]: https://github.com/yvt/r3/compare/[email protected]
26+
[0.1.1]: https://github.com/yvt/r3/compare/[email protected][email protected]
27+

‎src/r3_portkit/CHANGELOG.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
6+
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
7+
8+
## [Unreleased]
9+
10+
### Changed
11+
12+
- **Breaking (semver-exempt):** Change the target compiler version to `nightly-2021-10-18`
13+
14+
## [0.1.1] - 2020-12-20
15+
16+
### Changed
17+
18+
- **Breaking (semver-exempt):** Change the target compiler version to `nightly-2020-11-25`
19+
20+
### Added
21+
22+
- The POSIX backend now supports AArch64.
23+
24+
## 0.1.0 - 2020-11-03
25+
26+
Initial release.
27+
28+
[Unreleased]: https://github.com/yvt/r3/compare/[email protected]
29+
[0.1.1]: https://github.com/yvt/r3/compare/[email protected][email protected]
30+

‎src/r3_support_rp2040/CHANGELOG.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
6+
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
7+
8+
## [Unreleased]
9+
10+
## 0.1.0 - 2021-xx-xx
11+
12+
Initial release.
13+
14+
[Unreleased]: https://github.com/yvt/r3/compare/[email protected]
15+

‎src/r3_support_rza1/CHANGELOG.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
6+
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
7+
8+
## [Unreleased]
9+
10+
### Changed
11+
12+
- **Breaking (semver-exempt):** Change the target compiler version to `nightly-2021-10-18`
13+
14+
## 0.1.0 - 2020-11-03
15+
16+
Initial release.
17+
18+
[Unreleased]: https://github.com/yvt/r3/compare/[email protected]

0 commit comments

Comments
 (0)