Merge pull request #2233 from ehuss/msrv.yml-docs

Update documentation for msrv.yml change

Eliah Kagan committed 1 year ago

Commit 409708f2 parents cbf7445 10584b62 files · +2 −2Browse files

Unified · Split

2 files

README.md +1 −1
STABILITY.md +1 −1

README.md+1−1

@@ -203,7 +203,7 @@ cave resolve -x gitoxide · 202 unmodified lines
203	`cargo` is the Rust package manager which can easily be obtained through [rustup]. With it, you can build your own binary	203	`cargo` is the Rust package manager which can easily be obtained through [rustup]. With it, you can build your own binary
204	effortlessly and for your particular CPU for additional performance gains.	204	effortlessly and for your particular CPU for additional performance gains.
205		205
206	The minimum supported Rust version is [documented in the CI configuration](https://github.com/GitoxideLabs/gitoxide/blob/main/.github/workflows/msrv.yml#L23),	206	The minimum supported Rust version is [documented in the Cargo package](https://github.com/GitoxideLabs/gitoxide/blob/main/gix/Cargo.toml#L12-L14),
207	the latest stable one will work as well.	207	the latest stable one will work as well.
208		208
209	There are various build configurations, all of them are [documented here](https://docs.rs/crate/gitoxide/latest). The documentation should also be useful	209	There are various build configurations, all of them are [documented here](https://docs.rs/crate/gitoxide/latest). The documentation should also be useful

STABILITY.md+1−1

@@ -127,7 +127,7 @@ Minor version updates for new features can be released when needed assuming ther · 126 unmodified lines
127	## The _Minimal Supported Rust Version_ (->MSRV)	127	## The _Minimal Supported Rust Version_ (->MSRV)
128		128
129	The MSRV is automatically assumed to be the latest stable version for all crates with the following exception: `gix` and all it's dependencies must	129	The MSRV is automatically assumed to be the latest stable version for all crates with the following exception: `gix` and all it's dependencies must
130	adhere to an MSRV, as validated by the `msrv.yml` GitHub workflow.	130	adhere to an MSRV, as validated by the `ci.yml` GitHub workflow.
131		131
132	Increasing the MSRV is not considered a breaking change like is the case for most other crates in the community.	132	Increasing the MSRV is not considered a breaking change like is the case for most other crates in the community.
133		133