Skip to content

Commit f038ef6

Browse files
burrbullburrbull
committed
split README, up version, update and split changelog
1 parent 30a8298 commit f038ef6

File tree

14 files changed

+192
-43
lines changed

14 files changed

+192
-43
lines changed

‎CHANGELOG.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,21 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](http://keepachangelog.com/)
66
and this project adheres to [Semantic Versioning](http://semver.org/).
77

8-
## [Unreleased]
9-
8+
Newer releases see in [svd-rs/CHANGELOG.md](./svd-rs/CHANGELOG.md),
9+
[svd-parser/CHANGELOG.md](./svd-parser/CHANGELOG.md) and [svd-encoder/CHANGELOG.md](./svd-encoder/CHANGELOG.md).
10+
11+
## [v0.11.0] - 2021-10-02
12+
13+
- [breaking-change] Split `svd-parser` on `svd-rs`, `svd-parser` and `svd-encoder`
14+
- [breaking-change] Use `roxmltree` in `svd-parser` instead of `xmltree`
15+
for fast parsing and better error debug. `Parse` trait now requires `Config`
16+
- [breaking-change] Bump `xmltree` in `svd-encoder` to 0.10.
17+
- Fixed cluster encoding
18+
- Added `as_str`/`parse_str` for simple enums
19+
- Added `indexes` iterator for `DimElement`
20+
- For structs with builders added `modify_from` method, `validate` now public
21+
- [breaking-change] `build` and `modify_from` take `ValidateLevel`
22+
- [breaking-change] multiple `addressBlocks` now supported in `Peripheral`
1023
- Added custom `serde` (de)serializers for `BitRange`, `Register`,
1124
`Cluster` and `Field`. `camelCase` and `kebab-case` are used
1225
where it's needed to be more like SVD.
@@ -16,7 +29,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
1629
- [breaking-change] change encode format of some numbers to be
1730
more compatible with STM vendor's SVDs
1831
- [breaking-change] resort tags when encode
19-
- [breaking-change] Use `RegisterProperties` in `RegisterInfo`
32+
- [breaking-change] Use `RegisterProperties` in `RegisterInfo`, `Peripheral` nd `Device`
2033
instead of separate `size`, `access`, `reset_value` and `reset_mask`
2134

2235
## [v0.10.2] - 2021-04-30
@@ -153,7 +166,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
153166
- Initial SVD parser
154167
- A `parse` utility function to parse the contents of a SVD file (XML)
155168

156-
[Unreleased]: https://github.com/rust-embedded/svd/compare/v0.10.2...HEAD
169+
[Unreleased]: https://github.com/rust-embedded/svd/compare/v0.11.0...HEAD
170+
[v0.11.0]: https://github.com/rust-embedded/svd/compare/v0.10.2...v0.11.0
157171
[v0.10.2]: https://github.com/rust-embedded/svd/compare/v0.10.1...v0.10.2
158172
[v0.10.1]: https://github.com/rust-embedded/svd/compare/v0.10.0...v0.10.1
159173
[v0.10.0]: https://github.com/rust-embedded/svd/compare/v0.9.0...v0.10.0

‎README.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,12 @@
1-
[![crates.io](https://img.shields.io/crates/d/svd-parser.svg)](https://crates.io/crates/svd-parser)
2-
[![crates.io](https://img.shields.io/crates/v/svd-parser.svg)](https://crates.io/crates/svd-parser)
3-
[![Continuous Integration](https://github.com/rust-embedded/svd/workflows/Continuous%20Integration/badge.svg)](https://github.com/rust-embedded/svd/actions)
4-
[![Documentation](https://docs.rs/svd-parser/badge.svg)](https://docs.rs/svd-parser)
5-
6-
# `svd-parser`
7-
8-
> A CMSIS-SVD file parser
1+
# Rust SVD manipulating libraries
92

103
This project is developed and maintained by the [Tools team][team].
114

12-
## ["Documentation"](https://docs.rs/svd-parser)
5+
It consists of:
6+
7+
- [`svd-rs`](https://docs.rs/svd-rs). Basic structures and builders, also (de)serializers under `serde` feature.
8+
- [`svd-parser`](https://docs.rs/svd-parser). Library for parsing SVD XML source in Rust `Device` structure.
9+
- [`svd-encoder`](https://docs.rs/svd-encoder). Library for creating SVD XML.
1310

1411
## Minimum Supported Rust Version (MSRV)
1512

‎release.sh

Lines changed: 0 additions & 21 deletions
This file was deleted.

‎svd-encoder/CHANGELOG.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Change Log
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/)
6+
and this project adheres to [Semantic Versioning](http://semver.org/).
7+
8+
## [v0.11.0] - 2021-10-02
9+
- Splitted from `svd-parser`
10+
11+
Previous versions in common [changelog][../CHANGELOG.md].

‎svd-encoder/Cargo.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ license = "MIT OR Apache-2.0"
99
name = "svd-encoder"
1010
repository = "https://github.com/rust-embedded/svd"
1111
edition = "2018"
12-
version = "0.10.2"
12+
version = "0.11.0"
1313
readme = "README.md"
1414

1515
[dependencies]
16-
svd-rs = { version = "0.10.2", path = "../svd-rs"}
16+
svd-rs = { version = "0.11.0", path = "../svd-rs"}
1717
anyhow = "1.0.19"
1818
thiserror = "1.0.5"
1919

‎svd-encoder/README.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
[![crates.io](https://img.shields.io/crates/d/svd-encoder.svg)](https://crates.io/crates/svd-encoder)
2+
[![crates.io](https://img.shields.io/crates/v/svd-encoder.svg)](https://crates.io/crates/svd-encoder)
3+
[![Continuous Integration](https://github.com/rust-embedded/svd/workflows/Continuous%20Integration/badge.svg)](https://github.com/rust-embedded/svd/actions)
4+
[![Documentation](https://docs.rs/svd-encoder/badge.svg)](https://docs.rs/svd-encoder)
5+
6+
# `svd-encoder`
7+
8+
> A CMSIS-SVD file encoder
9+
10+
This project is developed and maintained by the [Tools team][team].
11+
12+
## ["Documentation"](https://docs.rs/svd-encoder)
13+
14+
## Minimum Supported Rust Version (MSRV)
15+
16+
This crate is guaranteed to compile on stable Rust 1.46.0 and up. It *might*
17+
compile with older versions but that may change in any new patch release.
18+
19+
## License
20+
21+
Licensed under either of
22+
23+
- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or
24+
http://www.apache.org/licenses/LICENSE-2.0)
25+
- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
26+
27+
at your option.
28+
29+
### Contribution
30+
31+
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the
32+
work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any
33+
additional terms or conditions.
34+
35+
## Code of Conduct
36+
37+
Contribution to this crate is organized under the terms of the [Rust Code of
38+
Conduct][CoC], the maintainer of this crate, the [Tools team][team], promises
39+
to intervene to uphold that code of conduct.
40+
41+
[CoC]: CODE_OF_CONDUCT.md
42+
[team]: https://github.com/rust-embedded/wg#the-tools-team

‎svd-parser/CHANGELOG.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Change Log
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/)
6+
and this project adheres to [Semantic Versioning](http://semver.org/).
7+
8+
## [v0.11.0] - 2021-10-02
9+
10+
Previous versions in common [changelog][../CHANGELOG.md].

‎svd-parser/Cargo.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,14 @@ license = "MIT OR Apache-2.0"
1010
name = "svd-parser"
1111
repository = "https://github.com/rust-embedded/svd"
1212
edition = "2018"
13-
version = "0.10.2"
13+
version = "0.11.0"
1414
readme = "README.md"
1515

1616
[features]
1717
derive-from = ["svd-rs/derive-from"]
1818

1919
[dependencies]
20-
svd-rs = { version = "0.10.2", path = "../svd-rs"}
20+
svd-rs = { version = "0.11.0", path = "../svd-rs"}
2121
roxmltree = "0.14.1"
2222
anyhow = "1.0.19"
2323
thiserror = "1.0.5"

‎svd-parser/README.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
[![crates.io](https://img.shields.io/crates/d/svd-parser.svg)](https://crates.io/crates/svd-parser)
2+
[![crates.io](https://img.shields.io/crates/v/svd-parser.svg)](https://crates.io/crates/svd-parser)
3+
[![Continuous Integration](https://github.com/rust-embedded/svd/workflows/Continuous%20Integration/badge.svg)](https://github.com/rust-embedded/svd/actions)
4+
[![Documentation](https://docs.rs/svd-parser/badge.svg)](https://docs.rs/svd-parser)
5+
6+
# `svd-parser`
7+
8+
> A CMSIS-SVD file parser
9+
10+
This project is developed and maintained by the [Tools team][team].
11+
12+
## ["Documentation"](https://docs.rs/svd-parser)
13+
14+
## Minimum Supported Rust Version (MSRV)
15+
16+
This crate is guaranteed to compile on stable Rust 1.46.0 and up. It *might*
17+
compile with older versions but that may change in any new patch release.
18+
19+
## License
20+
21+
Licensed under either of
22+
23+
- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or
24+
http://www.apache.org/licenses/LICENSE-2.0)
25+
- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
26+
27+
at your option.
28+
29+
### Contribution
30+
31+
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the
32+
work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any
33+
additional terms or conditions.
34+
35+
## Code of Conduct
36+
37+
Contribution to this crate is organized under the terms of the [Rust Code of
38+
Conduct][CoC], the maintainer of this crate, the [Tools team][team], promises
39+
to intervene to uphold that code of conduct.
40+
41+
[CoC]: CODE_OF_CONDUCT.md
42+
[team]: https://github.com/rust-embedded/wg#the-tools-team

‎svd-parser/src/lib.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ use crate::elementext::ElementExt;
3737
pub mod types;
3838

3939
#[derive(Clone, Copy, Debug, Default)]
40+
#[non_exhaustive]
4041
pub struct Config {
4142
pub validate_level: ValidateLevel,
4243
//pub expand_arrays: bool,

0 commit comments

Comments
 (0)