Document unstable --build-plan
authorEric Huss <eric@huss.org>
Sun, 27 May 2018 22:59:29 +0000 (15:59 -0700)
committerEric Huss <eric@huss.org>
Sun, 27 May 2018 22:59:29 +0000 (15:59 -0700)
src/doc/src/reference/unstable.md

index 6d206b78e2f780de9e1c2a9e9b271281353e35ec..91a85c99ba207947f79f1de742e1844ba5851441 100644 (file)
@@ -254,3 +254,16 @@ for each optional dependency, implicit features get created for any optional
 dependencies where a feature of the same name is not defined. However, if
 a feature of the same name as a dependency is defined, that feature must
 include the dependency as a requirement, as `foo = ["crate:foo"]`.
+
+
+### Build-plan
+* Tracking Issue: [rust-lang/cargo#5579](https://github.com/rust-lang/cargo/issues/5579)
+
+The `--build-plan` argument for the `build` command will output JSON with
+information about which commands would be run without actually executing
+anything. This can be useful when integrating with another build tool.
+Example:
+
+```
+cargo +nightly build --build-plan -Z unstable-options
+```