Skip to content

Commit

Permalink
[1.4.0] Updates to the README file
Browse files Browse the repository at this point in the history
  • Loading branch information
glessard committed Oct 17, 2024
1 parent 5cd7ead commit 11d4812
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,15 @@ let package = Package(

## Source Stability

The Swift System package is source stable. The version numbers follow [Semantic Versioning][semver] -- source breaking changes to public API can only land in a new major version.
The Swift System package supports three types of operating systems: Darwin, POSIX, and Windows. The source-stability status of the package differs according to the platform:

| Platform type | Stability |
| ----------------- | --------------- |
| Darwin | Source stable |
| POSIX | Source stable |
| Windows | Source unstable |

The package version numbers follow [Semantic Versioning][semver] -- source breaking changes to public API can only land in a new major version. However, platforms for which support has not reached source stability can have source-breaking changes in a new minor version.

[semver]: https://semver.org

Expand All @@ -79,7 +87,7 @@ The following table maps existing package releases to their minimum required Swi
| Package version | Swift version | Xcode release |
| ----------------------- | --------------- | ------------- |
| swift-system 1.3.x | >= Swift 5.8 | >= Xcode 14.3 |
| swift-system 1.4.x (unreleased) | >= Swift 5.9 | >= Xcode 15.0 |
| swift-system 1.4.x | >= Swift 5.9 | >= Xcode 15.0 |

We'd like this package to quickly embrace Swift language and toolchain improvements that are relevant to its mandate. Accordingly, from time to time, new versions of this package require clients to upgrade to a more recent Swift toolchain release. (This allows the package to make use of new language/stdlib features, build on compiler bug fixes, and adopt new package manager functionality as soon as they are available.) Patch (i.e., bugfix) releases will not increase the required toolchain version, but any minor (i.e., new feature) release may do so.

Expand Down

0 comments on commit 11d4812

Please sign in to comment.