Clarify -Z minimal-versions.
authorEric Huss <eric@huss.org>
Sun, 8 Apr 2018 17:40:50 +0000 (10:40 -0700)
committerEric Huss <eric@huss.org>
Sun, 8 Apr 2018 17:48:52 +0000 (10:48 -0700)
src/doc/src/reference/unstable.md

index a598032ebdcfb15005d7542d49ed8833fb8ddd74..c5989df51d5104d9be4cd622b1baf196faf7cd69 100644 (file)
@@ -155,6 +155,12 @@ When a `Cargo.lock` file is generated, the `-Z minimal-versions` flag will
 resolve the dependencies to the minimum semver version that will satisfy the
 requirements (instead of the greatest version).
 
+The intended use-case of this flag is to check, during continuous integration,
+that the versions specified in Cargo.toml are a correct reflection of the
+minimum versions that you are actually using. That is, if Cargo.toml says
+`foo = "1.0.0"` that you don't accidentally depend on features added only in
+`foo 1.5.0`.
+
 ### out-dir
 * Original Issue: [#4875](https://github.com/rust-lang/cargo/issues/4875)