From: Evgen Druzhynin Date: Tue, 17 Oct 2017 15:52:56 +0000 (+0300) Subject: Fix a documentation for package.build option. X-Git-Tag: archive/raspbian/0.35.0-2+rpi1~3^2^2^2^2^2^2^2~22^2~5^2~39^2 X-Git-Url: https://dgit.raspbian.org/?a=commitdiff_plain;h=60a3a81e051bce40ebe5d339d93b5b12ca5b6e2b;p=cargo.git Fix a documentation for package.build option. --- diff --git a/src/doc/book/src/reference/build-scripts.md b/src/doc/book/src/reference/build-scripts.md index 2c6fe3d81..a50f3afea 100644 --- a/src/doc/book/src/reference/build-scripts.md +++ b/src/doc/book/src/reference/build-scripts.md @@ -18,9 +18,10 @@ build = "build.rs" The Rust file designated by the `build` command (relative to the package root) will be compiled and invoked before anything else is compiled in the package, -allowing your Rust code to depend on the built or generated artifacts. Note that -if you do not specify a value for `build` but your package root does contains a -`"build.rs"` file, Cargo will compile and invoke this file for you. +allowing your Rust code to depend on the built or generated artifacts. +By default Cargo looks up for `"build.rs"` file in a package root (even if you +do not specify a value for `build`). Use `build = "custom_build_name.rs"` to specify +a custom build name or `build = false` to disable automatic detection of the build script. Some example use cases of the build command are: