Skip to content

Commit

Permalink
Merge pull request #1288 from stomar/cargo-build-scripts
Browse files Browse the repository at this point in the history
Improve Cargo / Build Scripts section
  • Loading branch information
marioidival authored Oct 29, 2019
2 parents 4804c5a + 3af0217 commit bb1ecf1
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions src/cargo/build_scripts.md
Original file line number Diff line number Diff line change
@@ -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.

Expand All @@ -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
Expand All @@ -29,10 +29,11 @@ here] that can be used.
The script provides output via stdout. All lines printed are written to
`target/debug/build/<pkg>/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
[cargo_specification]: https://doc.rust-lang.org/cargo/reference/build-scripts.html

0 comments on commit bb1ecf1

Please sign in to comment.