Skip to content

Commit

Permalink
Merge #1725
Browse files Browse the repository at this point in the history
1725: docs(README.md): adds details about MSRV by clap version r=pksunkara a=kbknapp



Co-authored-by: Kevin K <[email protected]>
  • Loading branch information
bors[bot] and kbknapp authored Mar 5, 2020
2 parents 3792941 + 2b017f5 commit 54f2072
Showing 1 changed file with 46 additions and 1 deletion.
47 changes: 46 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -545,14 +545,59 @@ clap = "3.0.0-beta.1"

This is inherently an unresolvable crate graph in Cargo right now. Cargo requires there's only one major version of a crate, and being in the same workspace these two crates must share a version. This is impossible in this location, though, as these version constraints cannot be met.

#### Minimum Version of Rust
#### Minimum Supported Version of Rust (MSRV)

`clap` will officially support current stable Rust, minus two releases, but may work with prior releases as well. For example, current stable Rust at the time of this writing is 1.38.0, meaning `clap` is guaranteed to compile with 1.36.0 and beyond.

At the 1.39.0 stable release, `clap` will be guaranteed to compile with 1.37.0 and beyond, etc.

Upon bumping the minimum version of Rust (assuming it's within the stable-2 range), it *must* be clearly annotated in the `CHANGELOG.md`

The following is a list of the minimum required version of Rust to compile `clap` by our `MAJOR.MINOR` version number (generated by [`cargo-msrv-table`](https://github.com/kbknapp/cargo-msrv-table)):

|clap| MSRV |
|---| --- |
|2.33| 1.24.1|
|2.32| 1.24.1|
|2.31| 1.24.1|
|2.30| 1.24.1|
|2.29| 1.24.1|
|2.28| 1.24.1|
|2.27| 1.24.1|
|2.26| 1.24.1|
|2.25| 1.24.1|
|2.24| 1.24.1|
|2.23| 1.24.1|
|2.22| 1.24.1|
|2.21| 1.24.1|
|2.20| 1.21.0|
|2.19| 1.12.1|
|2.18| 1.12.1|
|2.17| 1.12.1|
|2.16| 1.12.1|
|2.15| 1.12.1|
|2.14| 1.12.1|
|2.13| 1.12.1|
|2.12| 1.12.1|
|2.11| 1.12.1|
|2.10| 1.12.1|
|2.9| 1.12.1|
|2.8| 1.12.1|
|2.7| 1.12.1|
|2.6| 1.12.1|
|2.5| 1.12.1|
|2.4| 1.12.1|
|2.3| 1.12.1|
|2.2| 1.12.1|
|2.1| 1.6.0|
|2.0| 1.4.0|
|1.5| 1.4.0|
|1.4| 1.2.0|
|1.3| 1.1.0|
|1.2| 1.1.0|
|1.1| 1.0.0|
|1.0| 1.0.0|

#### Breaking Changes

`clap` takes a similar policy to Rust and will bump the major version number upon breaking changes with only the following exceptions:
Expand Down

0 comments on commit 54f2072

Please sign in to comment.