Merge pull request #37 from thejpster/prepare-release

Prepare release

Author: jonathanpallant

README.md

@@ -13,12 +13,13 @@ These libraries were originally written by Ferrous Systems, and are based on the
 [`cortex-m` libraries]: https://github.com/rust-embedded/cortex-m
 [Rust Embedded Devices Working Group]: https://github.com/rust-embedded
 
-There are currently three libraries here:
+There are currently five libraries here:
 
 * [cortex-ar](./cortex-ar/) - support library for Cortex-R and Cortex-A CPUs (like [cortex-m])
 * [cortex-r-rt](./cortex-r-rt/) - run-time library for Cortex-R CPUs (like [cortex-m-rt])
 * [cortex-a-rt](./cortex-a-rt/) - run-time library for Cortex-A CPUs (like [cortex-m-rt])
 * [arm-targets](./arm-targets/) - a helper library for your build.rs that sets various `--cfg` flags according to the current target
+* [cortex-ar-rt-macros](./cortex-ar-rt-macros/) - macros for `cortex-a-rt` and `cortex-r-rt` (this is an implementation detail - do not use this crate directly)
 
 There are also example programs for QEMU in the [examples](./examples/) folder.
 

arm-targets/CHANGELOG.md

@@ -0,0 +1,29 @@
+# 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/).
+
+## [Unreleased]
+
+No changes
+
+## [v0.2.0]
+
+### Added
+
+* `TargetInfo` struct
+* Armv7-A support
+
+### Changed
+
+* The `process_target` function returns a `TargetInfo`
+
+## [v0.1.0]
+
+Initial release
+
+[Unreleased]: https://github.com/rust-embedded/cortex-ar/compare/arm-targets-v0.2.0...HEAD
+[v0.2.0]: https://github.com/rust-embedded/cortex-ar/compare/arm-targets-v0.1.0...arm-targets-v0.2.0
+[v0.1.0]: https://github.com/rust-embedded/cortex-ar/releases/tag/arm-targets-v0.1.0

arm-targets/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 authors = [
     "Jonathan Pallant <[email protected]>",
-    "The Cortex-R Team <cortex-r@teams.rust-embedded.org>"
+    "The Embedded Devices Working Group Arm Team <arm@teams.rust-embedded.org>"
 ]
 categories = ["development-tools::build-utils"]
 description = "Compile-time feature detection for Arm processors"
@@ -12,6 +12,6 @@ readme = "README.md"
 repository = "https://github.com/rust-embedded/cortex-ar.git"
 homepage = "https://github.com/rust-embedded/cortex-ar.git"
 rust-version = "1.59"
-version = "0.1.0"
+version = "0.2.0"
 
 [dependencies]

arm-targets/README.md

@@ -29,12 +29,17 @@ This allows you to write Rust code in your firmware like:
 
 ## Minimum Supported Rust Version (MSRV)
 
-This crate is guaranteed to compile on stable Rust 1.82.0 and up. It *might*
-compile with older versions but that may change in any new patch release.
+This crate is guaranteed to compile on stable Rust 1.59.0 and up, as recorded
+by the `package.rust-version` property in `Cargo.toml`.
+
+Increasing the MSRV is not considered a breaking change and may occur in a
+minor version release (e.g. from `0.3.0` to `0.3.1`, because this is still a
+`0.x` release).
 
 ## Licence
 
-Copyright (c) Ferrous Systems, 2025
+* Copyright (c) Ferrous Systems
+* Copyright (c) The Rust Embedded Devices Working Group developers
 
 Licensed under either [MIT](./LICENSE-MIT) or [Apache-2.0](./LICENSE-APACHE) at
 your option.

cortex-a-rt/CHANGELOG.md

@@ -5,9 +5,13 @@ 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]
+## [Unreleased]
+
+No changes
+
+## [v0.1.0]
 
 Initial release
 
-[unreleased]: https://github.com/rust-embedded/cortex-ar/compare/cortex-a-rt-v0.1.0...HEAD
+[Unreleased]: https://github.com/rust-embedded/cortex-ar/compare/cortex-a-rt-v0.1.0...HEAD
 [v0.1.0]: https://github.com/rust-embedded/cortex-ar/releases/tag/cortex-a-rt-v0.1.0

cortex-a-rt/Cargo.toml

@@ -2,7 +2,7 @@
 authors = [
   "Robin Mueller <[email protected]>",
   "Jonathan Pallant <[email protected]>",
-  "The Cortex-R Team <cortex-r@teams.rust-embedded.org>"
+  "The Embedded Devices Working Group Arm Team <arm@teams.rust-embedded.org>"
 ]
 description = "Run-Time support for Arm Cortex-A"
 edition = "2021"
@@ -15,7 +15,7 @@ rust-version = "1.82"
 version = "0.1.0"
 
 [dependencies]
-cortex-ar = {version = "0.1.0", path = "../cortex-ar"}
+cortex-ar = {version = "0.2.0", path = "../cortex-ar"}
 cortex-ar-rt-macros = { path = "../cortex-ar-rt-macros", version = "=0.1.0" }
 
 [features]
@@ -26,7 +26,7 @@ eabi-fpu = []
 vfp-dp = []
 
 [build-dependencies]
-arm-targets = {version = "0.1.0", path = "../arm-targets"}
+arm-targets = {version = "0.2.0", path = "../arm-targets"}
 
 [package.metadata.docs.rs]
 targets = ["armv7a-none-eabihf"]

cortex-a-rt/README.md

@@ -1,4 +1,11 @@
-# Arm Cortex-A Run-Time
+# Run-time support for Arm Cortex-A (AArch32)
+
+This library implements a simple Arm vector table, suitable for getting into a
+Rust application running in System Mode. It also provides a reference start
+up method. Most Cortex-A based systems will require chip specific start-up
+code, so the start-up method can over overridden.
+
+See <https://docs.rs/cortex-a-rt> for detailed documentation.
 
 ## Features
 
@@ -8,8 +15,12 @@
 
 ## Minimum Supported Rust Version (MSRV)
 
-This crate is guaranteed to compile on stable Rust 1.82.0 and up. It *might*
-compile with older versions but that may change in any new patch release.
+This crate is guaranteed to compile on stable Rust 1.82.0 and up, as recorded
+by the `package.rust-version` property in `Cargo.toml`.
+
+Increasing the MSRV is not considered a breaking change and may occur in a
+minor version release (e.g. from `0.3.0` to `0.3.1`, because this is still a
+`0.x` release).
 
 ## Licence
 

cortex-a-rt/src/lib.rs

@@ -3,7 +3,7 @@
 //! This library implements a simple Arm vector table, suitable for getting into
 //! a Rust application running in System Mode. It also provides a reference
 //! start up method. Most Cortex-A based systems will require chip specific
-//! start-up code, so the start-up method can over overriden.
+//! start-up code, so the start-up method can over overridden.
 //!
 //! The default startup routine provided by this crate does not include any
 //! special handling for multi-core support because this is oftentimes

cortex-ar-rt-macros/CHANGELOG.md

@@ -0,0 +1,17 @@
+# 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/).
+
+## [Unreleased]
+
+No changes
+
+## [v0.1.0]
+
+Initial release
+
+[Unreleased]: https://github.com/rust-embedded/cortex-ar/compare/cortex-ar-rt-macros-v0.1.0...HEAD
+[v0.1.0]: https://github.com/rust-embedded/cortex-ar/releases/tag/cortex-ar-rt-macros-v0.1.0

cortex-ar-rt-macros/Cargo.toml

@@ -2,7 +2,7 @@
 authors = [
   "Robin Mueller <[email protected]>",
   "Jonathan Pallant <[email protected]>",
-  "The Cortex-R Team <cortex-r@teams.rust-embedded.org>"
+  "The Embedded Devices Working Group Arm Team <arm@teams.rust-embedded.org>"
 ]
 description = "Run-Time macros for Arm Cortex-A and Cortex-R"
 edition = "2021"