Skip to content

Commit 8b068f1

Browse files
therealprofburrbull
authored andcommitted
Bump version to 0.18 and add missing CHANGELOG.md entries
Signed-off-by: Daniel Egger <[email protected]>
1 parent 7fe3a52 commit 8b068f1

File tree

3 files changed

+33
-6
lines changed

3 files changed

+33
-6
lines changed

CHANGELOG.md

+29-2
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,24 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
77

88
## [Unreleased]
99

10+
## [v0.18.0] - 2021-04-17
11+
1012
### Added
1113

1214
- RegisterBlock trait (like `Deref`, but don't require `self` instance,
13-
only for fixed in memory peripherals)
15+
only for memory fixed peripherals)
1416

1517
- Support for registers with alternateGroup
1618

1719
- New `-m` switch generates a `mod.rs` file instead of `lib.rs`, which can
1820
be used as a module inside a crate without further modification.
1921

22+
- ESP32/XtensaLX6 support.
23+
24+
- Field array support.
25+
26+
- Add repr(transparent) to Reg struct
27+
2028
- Generated crates now contain the git commit hash and date of svd2rust
2129
compilation.
2230

@@ -46,8 +54,22 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
4654

4755
- [breaking-change] make `write_with_zero` method `unsafe` because the way it is
4856

57+
- Use complete path for cluster names
58+
59+
- Rename some generated variables.
60+
61+
- [breaking-change] Publishes the register spec zero-sized type and move all relevant register traits to that struct.
62+
63+
- [breaking-change] Removes the extra type parameter on Reg, making the register spec the sole authority on the shape of the register.
64+
65+
- Wrap register reader/writer and field readers in newtype wrappers, which significantly improves the documentation output.
66+
67+
- Improve documentation on generated registers and fields
68+
4969
- [breaking-change] remove `Variant<U, ENUM_A>`, use `Option<ENUM_A>` instead
5070

71+
- [breaking-change] Update `svd-parser` to `0.10`
72+
5173
- split out register size type (`RawType`) from `ResetValue` trait
5274

5375
- `anyhow` crate is used for error handling
@@ -66,6 +88,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
6688
interrupt number handling. The minimum supported `cortex-m` version is now
6789
**0.7** and `bare-metal` is not a dependency anymore.
6890

91+
### Removed
92+
93+
- Generated use of the register type aliases in favor of directly referencing `Reg<REGISTER_SPEC>`
94+
6995
## [v0.17.0] - 2019-12-31
7096

7197
### Fixed
@@ -560,7 +586,8 @@ peripheral.register.write(|w| w.field().set());
560586

561587
- Initial version of the `svd2rust` tool
562588

563-
[Unreleased]: https://github.com/rust-embedded/svd2rust/compare/v0.17.0...HEAD
589+
[Unreleased]: https://github.com/rust-embedded/svd2rust/compare/v0.18.0...HEAD
590+
[v0.18.0]: https://github.com/rust-embedded/svd2rust/compare/v0.17.0...v0.18.0
564591
[v0.17.0]: https://github.com/rust-embedded/svd2rust/compare/v0.16.1...v0.17.0
565592
[v0.16.1]: https://github.com/rust-embedded/svd2rust/compare/v0.16.0...v0.16.1
566593
[v0.16.0]: https://github.com/rust-embedded/svd2rust/compare/v0.15.2...v0.16.0

Cargo.toml

+2-2
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ keywords = [
2323
license = "MIT OR Apache-2.0"
2424
name = "svd2rust"
2525
repository = "https://github.com/rust-embedded/svd2rust/"
26-
version = "0.17.0"
26+
version = "0.18.0"
2727
readme = "README.md"
2828

2929
[[bin]]
@@ -43,7 +43,7 @@ anyhow = "1.0"
4343
thiserror = "1.0"
4444

4545
[dependencies.svd-parser]
46-
version = "0.10"
46+
version = "0.10.1"
4747
features = ["derive-from"]
4848

4949
[dependencies.syn]

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ This project is developed and maintained by the [Tools team][team].
1313

1414
## Minimum Supported Rust Version (MSRV)
1515

16-
The **generated code** is guaranteed to compile on stable Rust 1.37.0 and up.
16+
The **generated code** is guaranteed to compile on stable Rust 1.40.0 and up.
1717

18-
If you encounter compilation errors on any stable version newer than 1.37.0, please open an issue.
18+
If you encounter compilation errors on any stable version newer than 1.40.0, please open an issue.
1919

2020
# Testing Locally
2121

0 commit comments

Comments
 (0)