v0.13.0

Author: japaric

CHANGELOG.md

@@ -7,6 +7,39 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [v0.13.0] - 2018-05-12
+
+### Added
+
+- `svd2rust` now emits unions for registers that overlap (have the same address). Before `svd2rust`
+  would generate code for only one instance of overlapping registers for memory location. This
+  feature requires passing the `--nightly` to `svd2rust` as it generates code that requires a
+  nightly compiler to build.
+
+- `svd2rust` now also blacklists the `/` (backslash) and ` ` (space) characters. `svd2rust` removes
+  all blacklisted characters from peripheral, register, bitfield and enumeratedValues names.
+
+### Changed
+
+- This crate now compiles on the stable and beta channels.
+
+- [breaking-change] when the target is the cortex-m architecture `svd2rust` generates three files in
+  the current directory, instead of dumping the generated code to stdout.
+
+- [breaking-change] the syntax and expansion of the `interrupt!` macro has changed when the target
+  is the Cortex-M architecture.
+
+- [breaking-change] the code generated for the Cortex-M architecture now depends on newer versions
+  of the bare-metal, cortex-m and cortex-m-rt crates.
+
+- [breaking-change] when the target is the Cortex-M architecture the "rt" feature of the device
+  crate must enable the "device" feature of the cortex-m-rt dependency.
+
+### Removed
+
+- [breaking-change] `Interrupt` no longer implements the unstable `TryFrom` trait when the target is
+  the Cortex-M architecture.
+
 ## [v0.12.1] - 2018-05-06
 
 ### Added
@@ -340,7 +373,8 @@ peripheral.register.write(|w| w.field().set());
 
 - Initial version of the `svd2rust` tool
 
-[Unreleased]: https://github.com/japaric/svd2rust/compare/v0.12.0...HEAD
+[Unreleased]: https://github.com/japaric/svd2rust/compare/v0.13.0...HEAD
+[v0.13.0]: https://github.com/japaric/svd2rust/compare/v0.12.1...v0.13.0
 [v0.12.1]: https://github.com/japaric/svd2rust/compare/v0.12.0...v0.12.1
 [v0.12.0]: https://github.com/japaric/svd2rust/compare/v0.11.4...v0.12.0
 [v0.11.4]: https://github.com/japaric/svd2rust/compare/v0.11.3...v0.11.4

src/lib.rs

@@ -31,9 +31,10 @@
 //! When targeting the Cortex-M architecture `svd2rust` will generate three files in the current
 //! directory:
 //!
-//! - build.rs
-//! - device.x
-//! - lib.rs
+//! - `build.rs`, build script that places `device.x` somewhere the linker can find.
+//! - `device.x`, linker script that weakly aliases all the interrupt handlers to the default
+//! exception handler (`DefaultHandler`).
+//! - `lib.rs`, the generated code.
 //!
 //! All these files must be included in the same device crate. The `lib.rs` file contains several
 //! inlined modules and its not formatted. It's recommend to split it out using the [`form`] tool
@@ -60,9 +61,12 @@
 //! [dependencies]
 //! bare-metal = "0.2.0"
 //! cortex-m = "0.5.0"
-//! cortex-m-rt = "0.5.0"
 //! vcell = "0.1.0"
 //!
+//! [dependencies.cortex-m-rt]
+//! optional = true
+//! version = "0.5.0"
+//!
 //! [features]
 //! rt = ["cortex-m-rt/device"]
 //! ```
@@ -98,9 +102,12 @@
 //! [dependencies]
 //! bare-metal = "0.2.0"
 //! msp430 = "0.1.0"
-//! msp430-rt = "0.1.0"
 //! vcell = "0.1.0"
 //!
+//! [dependencies.msp430-rt]
+//! optional = true
+//! version = "0.1.0"
+//!
 //! [features]
 //! rt = ["msp430"]
 //! ```