split README, up version, update and split changelog

Author: burrbull

CHANGELOG.md

@@ -5,8 +5,21 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
-## [Unreleased]
-
+Newer releases see in [svd-rs/CHANGELOG.md](./svd-rs/CHANGELOG.md),
+[svd-parser/CHANGELOG.md](./svd-parser/CHANGELOG.md) and [svd-encoder/CHANGELOG.md](./svd-encoder/CHANGELOG.md).
+
+## [v0.11.0] - 2021-10-02
+
+- [breaking-change] Split `svd-parser` on `svd-rs`, `svd-parser` and `svd-encoder`
+- [breaking-change] Use `roxmltree` in `svd-parser` instead of `xmltree`
+  for fast parsing and better error debug. `Parse` trait now requires `Config`
+- [breaking-change] Bump `xmltree` in `svd-encoder` to 0.10.
+- Fixed cluster encoding
+- Added `as_str`/`parse_str` for simple enums
+- Added `indexes` iterator for `DimElement`
+- For structs with builders added `modify_from` method, `validate` now public
+- [breaking-change] `build` and `modify_from` take `ValidateLevel`
+- [breaking-change] multiple `addressBlocks` now supported in `Peripheral`
 - Added custom `serde` (de)serializers for `BitRange`, `Register`,
   `Cluster` and `Field`. `camelCase` and `kebab-case` are used
   where it's needed to be more like SVD.
@@ -16,7 +29,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - [breaking-change] change encode format of some numbers to be
   more compatible with STM vendor's SVDs
 - [breaking-change] resort tags when encode
-- [breaking-change] Use `RegisterProperties` in `RegisterInfo`
+- [breaking-change] Use `RegisterProperties` in `RegisterInfo`, `Peripheral` nd `Device`
   instead of separate `size`, `access`, `reset_value` and `reset_mask`
 
 ## [v0.10.2] - 2021-04-30
@@ -153,7 +166,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - Initial SVD parser
 - A `parse` utility function to parse the contents of a SVD file (XML)
 
-[Unreleased]: https://github.com/rust-embedded/svd/compare/v0.10.2...HEAD
+[Unreleased]: https://github.com/rust-embedded/svd/compare/v0.11.0...HEAD
+[v0.11.0]: https://github.com/rust-embedded/svd/compare/v0.10.2...v0.11.0
 [v0.10.2]: https://github.com/rust-embedded/svd/compare/v0.10.1...v0.10.2
 [v0.10.1]: https://github.com/rust-embedded/svd/compare/v0.10.0...v0.10.1
 [v0.10.0]: https://github.com/rust-embedded/svd/compare/v0.9.0...v0.10.0

README.md

@@ -1,15 +1,12 @@
-[![crates.io](https://img.shields.io/crates/d/svd-parser.svg)](https://crates.io/crates/svd-parser)
-[![crates.io](https://img.shields.io/crates/v/svd-parser.svg)](https://crates.io/crates/svd-parser)
-[![Continuous Integration](https://github.com/rust-embedded/svd/workflows/Continuous%20Integration/badge.svg)](https://github.com/rust-embedded/svd/actions)
-[![Documentation](https://docs.rs/svd-parser/badge.svg)](https://docs.rs/svd-parser)
-
-# `svd-parser`
-
-> A CMSIS-SVD file parser
+# Rust SVD manipulating libraries
 
 This project is developed and maintained by the [Tools team][team].
 
-## ["Documentation"](https://docs.rs/svd-parser)
+It consists of:
+
+- [`svd-rs`](https://docs.rs/svd-rs). Basic structures and builders, also (de)serializers under `serde` feature.
+- [`svd-parser`](https://docs.rs/svd-parser). Library for parsing SVD XML source in Rust `Device` structure.
+- [`svd-encoder`](https://docs.rs/svd-encoder). Library for creating SVD XML.
 
 ## Minimum Supported Rust Version (MSRV)
 

release.sh

@@ -0,0 +1,11 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## [v0.11.0] - 2021-10-02
+- Splitted from `svd-parser`
+
+Previous versions in common [changelog][../CHANGELOG.md].

svd-encoder/CHANGELOG.md

@@ -9,11 +9,11 @@ license = "MIT OR Apache-2.0"
 name = "svd-encoder"
 repository = "https://github.com/rust-embedded/svd"
 edition = "2018"
-version = "0.10.2"
+version = "0.11.0"
 readme = "README.md"
 
 [dependencies]
-svd-rs = { version = "0.10.2", path = "../svd-rs"}
+svd-rs = { version = "0.11.0", path = "../svd-rs"}
 anyhow = "1.0.19"
 thiserror = "1.0.5"
 

svd-encoder/Cargo.toml

@@ -0,0 +1,42 @@
+[![crates.io](https://img.shields.io/crates/d/svd-encoder.svg)](https://crates.io/crates/svd-encoder)
+[![crates.io](https://img.shields.io/crates/v/svd-encoder.svg)](https://crates.io/crates/svd-encoder)
+[![Continuous Integration](https://github.com/rust-embedded/svd/workflows/Continuous%20Integration/badge.svg)](https://github.com/rust-embedded/svd/actions)
+[![Documentation](https://docs.rs/svd-encoder/badge.svg)](https://docs.rs/svd-encoder)
+
+# `svd-encoder`
+
+> A CMSIS-SVD file encoder
+
+This project is developed and maintained by the [Tools team][team].
+
+## ["Documentation"](https://docs.rs/svd-encoder)
+
+## Minimum Supported Rust Version (MSRV)
+
+This crate is guaranteed to compile on stable Rust 1.46.0 and up. It *might*
+compile with older versions but that may change in any new patch release.
+
+## License
+
+Licensed under either of
+
+- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or
+  http://www.apache.org/licenses/LICENSE-2.0)
+- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
+
+at your option.
+
+### Contribution
+
+Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the
+work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any
+additional terms or conditions.
+
+## Code of Conduct
+
+Contribution to this crate is organized under the terms of the [Rust Code of
+Conduct][CoC], the maintainer of this crate, the [Tools team][team], promises
+to intervene to uphold that code of conduct.
+
+[CoC]: CODE_OF_CONDUCT.md
+[team]: https://github.com/rust-embedded/wg#the-tools-team

svd-encoder/README.md

@@ -0,0 +1,10 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## [v0.11.0] - 2021-10-02
+
+Previous versions in common [changelog][../CHANGELOG.md].

svd-parser/CHANGELOG.md

@@ -10,14 +10,14 @@ license = "MIT OR Apache-2.0"
 name = "svd-parser"
 repository = "https://github.com/rust-embedded/svd"
 edition = "2018"
-version = "0.10.2"
+version = "0.11.0"
 readme = "README.md"
 
 [features]
 derive-from = ["svd-rs/derive-from"]
 
 [dependencies]
-svd-rs = { version = "0.10.2", path = "../svd-rs"}
+svd-rs = { version = "0.11.0", path = "../svd-rs"}
 roxmltree = "0.14.1"
 anyhow = "1.0.19"
 thiserror = "1.0.5"

svd-parser/Cargo.toml

@@ -0,0 +1,42 @@
+[![crates.io](https://img.shields.io/crates/d/svd-parser.svg)](https://crates.io/crates/svd-parser)
+[![crates.io](https://img.shields.io/crates/v/svd-parser.svg)](https://crates.io/crates/svd-parser)
+[![Continuous Integration](https://github.com/rust-embedded/svd/workflows/Continuous%20Integration/badge.svg)](https://github.com/rust-embedded/svd/actions)
+[![Documentation](https://docs.rs/svd-parser/badge.svg)](https://docs.rs/svd-parser)
+
+# `svd-parser`
+
+> A CMSIS-SVD file parser
+
+This project is developed and maintained by the [Tools team][team].
+
+## ["Documentation"](https://docs.rs/svd-parser)
+
+## Minimum Supported Rust Version (MSRV)
+
+This crate is guaranteed to compile on stable Rust 1.46.0 and up. It *might*
+compile with older versions but that may change in any new patch release.
+
+## License
+
+Licensed under either of
+
+- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or
+  http://www.apache.org/licenses/LICENSE-2.0)
+- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
+
+at your option.
+
+### Contribution
+
+Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the
+work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any
+additional terms or conditions.
+
+## Code of Conduct
+
+Contribution to this crate is organized under the terms of the [Rust Code of
+Conduct][CoC], the maintainer of this crate, the [Tools team][team], promises
+to intervene to uphold that code of conduct.
+
+[CoC]: CODE_OF_CONDUCT.md
+[team]: https://github.com/rust-embedded/wg#the-tools-team

svd-parser/README.md

@@ -37,6 +37,7 @@ use crate::elementext::ElementExt;
 pub mod types;
 
 #[derive(Clone, Copy, Debug, Default)]
+#[non_exhaustive]
 pub struct Config {
     pub validate_level: ValidateLevel,
     //pub expand_arrays: bool,