itsscb/cargo
1
0
Fork 0
mirror of https://github.com/rust-lang/cargo.git synced 2025-10-01 11:30:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

Auto merge of #4635 - dethoter:4430, r=alexcrichton

Browse Source 
Fix a documentation for package.build option.

Fix for #4430.
This commit is contained in:
bors 2017-10-17 17:32:27 +00:00
commit 7c47eeb29f
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/doc/book/src/reference/build-scripts.md
View File

@ -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: