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 #12482 - rukai:rerun-if-changed-docs, r=weihanglo

Browse Source 
docs: make the env var source of rerun-if-env-changed clearer

closes https://github.com/rust-lang/cargo/issues/12403

### What does this PR try to resolve?

The wording of the documentation on [rerun-if-env-changed](https://doc.rust-lang.org/cargo/reference/build-scripts.html#cargorerun-if-env-changedname) was misleading which led me to be confused by the behavior of cargo and then raise https://github.com/rust-lang/cargo/issues/12403
These changes should avoid users being confused by this in the future.
This commit is contained in:
bors 2023-08-12 00:42:04 +00:00
commit 65cee64656
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/doc/src/reference/build-scripts.md
View File

@ -346,8 +346,10 @@ The `rerun-if-env-changed` instruction tells Cargo to re-run the build script
if the value of an environment variable of the given name has changed. if the value of an environment variable of the given name has changed.
Note that the environment variables here are intended for global environment Note that the environment variables here are intended for global environment
variables like `CC` and such, it is not necessary to use this for environment variables like `CC` and such, it is not possible to use this for environment
variables like `TARGET` that Cargo sets. variables like `TARGET` that [Cargo sets for build scripts][build-env]. The
environment variables in use are those received by `cargo` invocations, not
those received by the executable of the build script.
### The `links` Manifest Key ### The `links` Manifest Key