Skip to content

Commit

Permalink
Add note about RUSTFLAGS removal from build scripts.
Browse files Browse the repository at this point in the history
  • Loading branch information
ehuss committed Nov 30, 2021
1 parent 2ad6cb7 commit cfee33e
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 5 deletions.
9 changes: 8 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,11 @@

### Changed

-`RUSTFLAGS` is no longer set for build scripts. This change was made in
1.55, but the release notes did not highlight this change. Build scripts
should use `CARGO_ENCODED_RUSTFLAGS` instead. See the
[documentation](https://doc.rust-lang.org/nightly/cargo/reference/environment-variables.html#environment-variables-cargo-sets-for-build-scripts)
for more details.
- The `cargo version` command now includes some extra information.
[#9968](https://github.com/rust-lang/cargo/pull/9968)
- Updated libgit2 to 1.3 which brings in a number of fixes and changes to git
Expand Down Expand Up @@ -186,8 +191,10 @@
- The package definition in `cargo metadata` now includes the `"default_run"`
field from the manifest.
[#9550](https://github.com/rust-lang/cargo/pull/9550)
- Build scripts now have access to the following environment variables:
- Build scripts now have access to the following environment variables:
`RUSTC_WRAPPER`, `RUSTC_WORKSPACE_WRAPPER`, `CARGO_ENCODED_RUSTFLAGS`.
`RUSTFLAGS` is no longer set for build scripts; they should use
`CARGO_ENCODED_RUSTFLAGS` instead.
[docs](https://doc.rust-lang.org/nightly/cargo/reference/environment-variables.html#environment-variables-cargo-sets-for-build-scripts)
[#9601](https://github.com/rust-lang/cargo/pull/9601)
- Added `cargo d` as an alias for `cargo doc`.
Expand Down
8 changes: 4 additions & 4 deletions src/doc/src/reference/environment-variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -353,10 +353,10 @@ let out_dir = env::var("OUT_DIR").unwrap();
changed by editing `.cargo/config.toml`; see the documentation
about [cargo configuration][cargo-config] for more
information.
* `CARGO_ENCODED_RUSTFLAGS` — extra flags that Cargo invokes `rustc`
with, separated by a `0x1f` character
(ASCII Unit Separator). See
[`build.rustflags`].
* `CARGO_ENCODED_RUSTFLAGS` — extra flags that Cargo invokes `rustc` with,
separated by a `0x1f` character (ASCII Unit Separator). See
[`build.rustflags`]. Note that since Rust 1.55, `RUSTFLAGS` is removed from
the environment; scripts should use `CARGO_ENCODED_RUSTFLAGS` instead.
* `CARGO_PKG_<var>` - The package information variables, with the same names and values as are [provided during crate building][variables set for crates].

[unix-like platforms]: ../../reference/conditional-compilation.html#unix-and-windows
Expand Down

0 comments on commit cfee33e

Please sign in to comment.