diff --git a/src/cargo/build_scripts.md b/src/cargo/build_scripts.md index c5da00db6a..6db3afe90a 100644 --- a/src/cargo/build_scripts.md +++ b/src/cargo/build_scripts.md @@ -1,7 +1,7 @@ # Build Scripts -Sometimes a normal build from cargo is not enough. Perhaps your crate needs some -pre-requisites before cargo will successfully compile, things like code +Sometimes a normal build from `cargo` is not enough. Perhaps your crate needs +some pre-requisites before `cargo` will successfully compile, things like code generation, or some native code that needs to be compiled. To solve this problem we have build scripts that Cargo can run. @@ -20,7 +20,7 @@ default. ## How to use a build script The build script is simply another Rust file that will be compiled and invoked -prior to compiling anything else in the package. Hence it can be used to fulfil +prior to compiling anything else in the package. Hence it can be used to fulfill pre-requisites of your crate. Cargo provides the script with inputs via environment variables [specified @@ -29,10 +29,11 @@ here] that can be used. The script provides output via stdout. All lines printed are written to `target/debug/build//output`. Further, lines prefixed with `cargo:` will be interpreted by Cargo directly and hence can be used to define parameters for the -packages compilation. +package's compilation. -For further specification and examples have a read of the [cargo specification]. +For further specification and examples have a read of the +[Cargo specification][cargo_specification]. [specified here]: https://doc.rust-lang.org/cargo/reference/environment-variables.html#environment-variables-cargo-sets-for-build-scripts -[cargo specification]: https://doc.rust-lang.org/cargo/reference/build-scripts.html \ No newline at end of file +[cargo_specification]: https://doc.rust-lang.org/cargo/reference/build-scripts.html