Skip to content

Commit 8fc3556

Browse files
authored
Update CHANGELOG for 0.1.1 (#179)
1 parent 5e37157 commit 8fc3556

File tree

6 files changed

+21
-13
lines changed

6 files changed

+21
-13
lines changed

CHANGELOG.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,7 @@ All notable changes to this project will be documented in this file.
55
This changelog's format is based on
66
[Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
77

8-
This project follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
9-
While still in major version `0`, source-stability is only guaranteed within
10-
minor versions (e.g. between `0.0.3` and `0.0.4`). If you want to guard against
11-
potentially source-breaking package updates, you can specify your package
12-
dependency using `.upToNextMinor(from: "0.0.1")` as the requirement.
8+
> Important: See [source stability](https://github.com/apple/swift-mmio#source-stability) for details on major version "0".
139
1410
## [Unreleased]
1511

@@ -21,6 +17,12 @@ Add new items at the end of the relevant section under **Unreleased**.
2117

2218
---
2319

20+
## [0.1.1] - 2025-11-08
21+
22+
- Minor documention improvements.
23+
24+
The 0.1.1 release includes contributions from [rauhul]. Thank you!
25+
2426
## [0.1.0] - 2025-09-05
2527

2628
- Major feature release with new SVD tooling and API enhancements
@@ -146,7 +148,8 @@ The 0.0.1 release includes contributions from [rauhul]. Thank you!
146148

147149
<!-- Link references for releases -->
148150

149-
[Unreleased]: https://github.com/apple/swift-mmio/compare/0.1.0...HEAD
151+
[Unreleased]: https://github.com/apple/swift-mmio/compare/0.1.1...HEAD
152+
[0.1.1]: https://github.com/apple/swift-mmio/releases/tag/0.1.1
150153
[0.1.0]: https://github.com/apple/swift-mmio/releases/tag/0.1.0
151154
[0.0.2]: https://github.com/apple/swift-mmio/releases/tag/0.0.2
152155
[0.0.1]: https://github.com/apple/swift-mmio/releases/tag/0.0.1

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ control.cr1.modify { $0.en = true }
3232
Swift MMIO supports use with the Swift Package Manager. First, add the Swift MMIO repository to your Package's dependencies:
3333

3434
```swift
35-
.package(url: "https://github.com/apple/swift-mmio", from: "0.1.0"),
35+
.package(url: "https://github.com/apple/swift-mmio", from: "0.1.1"),
3636
```
3737

3838
Second, add the `MMIO` library to your target's dependencies:
@@ -49,12 +49,17 @@ Finally, `import MMIO` in your Swift source code.
4949

5050
### Source Stability
5151

52-
This project follows semantic versioning. While still in major version `0`, source-stability is only guaranteed within minor versions (e.g. between `0.0.3` and `0.0.4`). If you want to guard against potentially source-breaking package updates, you can specify your package dependency using `.upToNextMinor(from: "0.0.2")` as the requirement:
52+
Swift MMIO follows semantic versioning. While the package is in major version `0` (e.g., `0.0.x`), source stability is only guaranteed within minor versions. For example, code written for `0.0.2` is compatible with `0.0.3`, but `0.1.0` might introduce source-breaking changes.
53+
54+
To protect your project against potentially source-breaking updates during the `0.x.y` development phase, specify your package dependency using the `.upToNextMinor(from:)` requirement:
5355

5456
```swift
55-
.package(url: "https://github.com/apple/swift-mmio", .upToNextMinor(from: "0.1.0")),
57+
.package(url: "https://github.com/apple/swift-mmio.git", .upToNextMinor(from: "0.0.2")),
5658
```
5759

60+
This ensures that `swift package update` fetches compatible updates within the `0.0.x` series (e.g., `0.0.3`, `0.0.4`) but does not automatically update to `0.1.0` if it becomes available.
61+
62+
5863
## Documentation
5964

6065
For guides, articles, and API documentation see the [Package's documentation on the Web][docs] or in Xcode.

Sources/MMIO/Documentation.docc/Essentials/Installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Integrate Swift MMIO into your project using Swift Package Manager.
1313
name: "MyApplication",
1414
dependencies: [
1515
// Add Swift MMIO package dependency
16-
.package(url: "https://github.com/apple/swift-mmio.git", from: "0.0.2"),
16+
.package(url: "https://github.com/apple/swift-mmio.git", from: "0.1.1"),
1717
],
1818
//...
1919
```

Sources/SVD/Documentation.docc/Documentation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ This library is intended to enable development of _tooling_ surrounding SVD file
2121
`SVD` supports use with the Swift Package Manager. First, add the Swift MMIO repository to your Package's dependencies:
2222

2323
```swift
24-
.package(url: "https://github.com/apple/swift-mmio.git", from: "0.0.2"),
24+
.package(url: "https://github.com/apple/swift-mmio.git", from: "0.1.1"),
2525
```
2626

2727
> Important: See [source stability](https://github.com/apple/swift-mmio#source-stability) for details on major version "0".

Sources/SVD2Swift/Documentation.docc/UsingSVD2Swift.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Clone the swift-mmio repository:
1818

1919
```console
2020
$ git clone git@github.com:apple/swift-mmio.git
21-
$ git checkout 0.0.2
21+
$ git checkout 0.1.1
2222
```
2323

2424
Build `svd2swift` in release mode:

Sources/SVD2Swift/Documentation.docc/UsingSVD2SwiftPlugin.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The `SVD2SwiftPlugin` integrates `svd2swift` into the SwiftPM build process, all
1313
First, add the Swift MMIO repository to your Package's dependencies:
1414

1515
```swift
16-
.package(url: "https://github.com/apple/swift-mmio.git", from: "0.0.2"),
16+
.package(url: "https://github.com/apple/swift-mmio.git", from: "0.1.1"),
1717
```
1818

1919
> Important: See [source stability](https://github.com/apple/swift-mmio#source-stability) for details on major version "0".

0 commit comments

Comments
 (0)