`OUT_DIR` variable not set #3368

Razican · 2016-12-04T20:57:15Z

Some Travis jobs are not compiling due to OUT_DIR not being present on nightly on my build.rs script. Is this an expected behaviour? how could it be fixed?

Example failure: https://travis-ci.org/SUPERAndroidAnalyzer/super/jobs/181113222#L146

The text was updated successfully, but these errors were encountered:

joshtriplett · 2016-12-05T00:50:53Z

I can reproduce this with "cargo install ripgrep" using a cargo built from latest cargo git. Debugging...

joshtriplett · 2016-12-05T01:32:49Z

Looks like commit 41579ba caused this issue.

upsuper · 2016-12-07T08:17:04Z

This breaks building servo/rust-bindgen as well.

JIghtuse · 2016-12-07T10:54:36Z

cargo even has failing test for me with the same symptoms: http://paste.fedoraproject.org/500936/48110771/

Can't build ripgrep too.

SimonSapin · 2016-12-07T23:00:08Z

I’ve managed to build bindgen by replacing env! in the build script with std::env::var: rust-lang/rust-bindgen#323

SimonSapin · 2016-12-07T23:02:38Z

Still, it looks like this is a breaking change. So Cargo should probably revert to providing these variables when compiling a build script. At least for a while, with a warning that this will change.

joshtriplett · 2016-12-07T23:13:37Z

It looks like commit 95193ca clarified the documentation to state that Cargo doesn't set these environment variables when building the build script, only when running it, even though Cargo did actually set them when building the build script as well. A later commit in Cargo then made the behavior match the documentation.

This does indeed represent a breaking change from the existing behavior, and existing build.rs scripts relied on the existing behavior.

The errors were caused by the missing env $OUT_DIR which should be set by cargo, see [here](rust-lang/cargo#3368).

The errors were caused by the missing env $OUT_DIR which should be set by cargo. [Related issue](rust-lang/cargo#3368).

alexcrichton · 2016-12-09T00:44:17Z

Ah this is definitely an accidental regression! Yes env!("OUT_DIR") is likely not what you want but rather std::env::var is correct in build scripts. The env! version is the out dir that the build script was built with, and the env::var version is for when the build script is being run.

I'm kinda surprised that env! ever worked...

alexcrichton · 2016-12-09T00:52:44Z

Well... so this was a "regression" but also a bug fix at the same time. The OUT_DIR environment variable can be different when the build script is being compiled compared to when the build script is being run. Notably during cross compilation these two can be different. This means that crates which use env!("OUT_DIR") I believe are broken for cross compiles where crates which use env::var("OUT_DIR") will correctly work with cross compiles.

To those hitting this issue, could you confirm that the crate hasn't been used for cross compiles? And perhaps if it has have weird issues arisen?

We could add a fix for this but I'm tempted to avoid doing so if we can (as it's "incorrect" to rely on the old behavior). If it's possible to fixup the packages in question quickly that'd be best, but if there's ongoing pain then I can change Cargo back to the previous behavior.

joshtriplett · 2016-12-09T03:11:52Z

@alexcrichton I've seen various crates get fixed for this change (which, at a minimum, needs documentation in release notes).

It'd be good to be able to build existing packages with new Cargo. For the most part, Cargo has maintained backward compatibility across many versions. On the other hand, I do agree that crates shouldn't rely on the old behavior, and it would indeed have broken cross-compiles.

I don't see an obvious way to work-but-warn in this case, without awful hacks (such as somehow substituting in a version of env! that checks the environment variable name and produces a warning).

alexcrichton · 2016-12-11T18:59:31Z

Yes my only worry is if crates can't be updated. Crates can use std::env::var and work across all versions of Cargo, so if a crate can be proactively updated I'm not too worried about it.

SimonSapin · 2016-12-11T19:54:49Z

Can crater be used to find out what on crates.io is broken by this change?

alexcrichton · 2016-12-13T00:02:04Z

@SimonSapin I believe so, yes, we should see it in the next crater run (as soon as it's working)

Caused by rust-lang/cargo#3368. See rust-lang/cargo#3368 (comment) for more information.

The env! method pulls the variable at *compile time* as opposed to runtime. This can cause breakage in scenarios with cross compilation, for example. Currently there's also a pending change to Cargo on the beta release of Rust which breaks the usage of env! (rust-lang/cargo#3368). We may roll that change back, but I figured it'd be good to head off future breakage anyway!

brson · 2016-12-29T18:27:15Z

gazetta-bin-0.1.6 hits this.

The env! method pulls the variable at *compile time* as opposed to runtime. This can cause breakage in scenarios with cross compilation, for example. Currently there's also a pending change to Cargo on the beta release of Rust which breaks the usage of env! (rust-lang/cargo#3368). We may roll that change back, but I figured it'd be good to head off future breakage anyway!

alexcrichton · 2016-12-29T19:25:46Z

PR sent as Stebalien/gazetta-bin#1

brson · 2016-12-30T21:17:49Z

pinyin-0.0.5 hits this. (Edit: oh you've fixed pinyin)

brson · 2016-12-30T22:05:55Z

zip_codes-0.0.1 is affected cc @SkylerLipthay

SkylerLipthay · 2016-12-31T00:17:39Z

Alex fixed this with SkylerLipthay/zip_codes#2, which has been merged! zip_codes 0.1.0 was subsequently released.

brson · 2016-12-31T00:57:05Z

Affects rasen-0.1.0

https://tools.taskcluster.net/task-inspector/#_6XeY7pIRjKvuBDVVuFMFQ/0

brson · 2016-12-31T00:57:17Z

Great @SkylerLipthay! Sorry for the inconvenience.

alexcrichton · 2016-12-31T03:22:41Z

@brson I think pinyin and rasen were both addressed here -- rust-lang/rust#38391 (comment)

brson · 2017-01-05T01:53:18Z

lmdb-rs 0.7.3's test suite is affected. cc @vhbit

Caused by rust-lang/cargo#3368. Now the method for determining path for DB tests is exact copy from `cargo`.

alexcrichton · 2017-01-06T01:26:50Z

@brson looks like that was fixed by vhbit/lmdb-rs@25c1fdc

alexcrichton · 2017-01-12T17:10:27Z

Ok we've decided to close this as working as intended, but if any projects need help migrating please just let me know!

abonander · 2018-03-12T07:12:29Z

@alexcrichton The story isn't over, however: abonander/mime_guess#33

This invocation is at the build time of the crate: https://github.com/abonander/mime_guess/blob/master/src/lib.rs#L16

When OUT_DIR should be defined at that point because there is a build script.

alexcrichton · 2018-03-12T14:01:06Z

@abonander maybe the version of Cargo there is too old to recognize the implicit build script via build.rs?

abonander · 2018-03-12T21:31:26Z

@alexcrichton Good call! The issue reporter was running a Docker container with a super-outdated Cargo.

joshtriplett mentioned this issue Dec 5, 2016

cargo fails if it can't find optional dependencies, even if corresponding feature not enabled #3369

Merged

knight42 added a commit to uutils/coreutils that referenced this issue Dec 8, 2016

Temporary fix for testing errors

c000059

The errors were caused by the missing env $OUT_DIR which should be set by cargo, see [here](rust-lang/cargo#3368).

knight42 added a commit to uutils/coreutils that referenced this issue Dec 8, 2016

Temporary fix for errors in testing

a0ff0f6

The errors were caused by the missing env $OUT_DIR which should be set by cargo. [Related issue](rust-lang/cargo#3368).

knight42 mentioned this issue Dec 8, 2016

Temporary fix for errors in testing uutils/coreutils#1011

Merged

brson mentioned this issue Dec 15, 2016

rust 1.15 regression in cargo CARGO_OUT handling rust-lang/rust#38391

Closed

brendanzab mentioned this issue Dec 18, 2016

Never assume that the kind of a type variable is ‘type’ gluon-lang/gluon#227

Closed

brendanzab added a commit to brendanzab/gluon that referenced this issue Dec 18, 2016

Fix build failure due to missing environment var

a30f6c2

Caused by rust-lang/cargo#3368. See rust-lang/cargo#3368 (comment) for more information.

brendanzab mentioned this issue Dec 18, 2016

Fix build failure due to missing environment var gluon-lang/gluon#228

Merged

alexcrichton mentioned this issue Dec 28, 2016

Use env::var_os intead of env! in build script mozillazg/rust-pinyin#5

Merged

alexcrichton mentioned this issue Dec 28, 2016

Use env::var_os intead of env! in build script SkylerLipthay/zip_codes#2

Merged

alexcrichton mentioned this issue Dec 29, 2016

Use env::var intead of env! in build script Stebalien/gazetta-bin#1

Merged

brson mentioned this issue Dec 30, 2016

Regression in wait-timeout-0.1.13 test suite in Rust 1.15 rust-lang/rust#38721

Closed

brson mentioned this issue Dec 30, 2016

Regression in cargo-check 0.2.2 test suite in Rust 1.15 rust-lang/rust#38722

Closed

vhbit added a commit to vhbit/lmdb-rs that referenced this issue Jan 5, 2017

Fixes broken tests on nightly

25c1fdc

Caused by rust-lang/cargo#3368. Now the method for determining path for DB tests is exact copy from `cargo`.

mbrubeck mentioned this issue Jan 12, 2017

Regression in vk_generator 0.2.1, Rust 1.15 rust-lang/rust#38974

Closed

alexcrichton closed this as completed Jan 12, 2017

pka mentioned this issue Mar 11, 2018

Build fails with environment variable OUT_DIR not defined abonander/mime_guess#33

Closed

clearloop mentioned this issue Aug 28, 2020

Supports ropsten ethereum header source for test usages darwinia-network/shadow#66

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

`OUT_DIR` variable not set #3368

`OUT_DIR` variable not set #3368

Razican commented Dec 4, 2016

joshtriplett commented Dec 5, 2016

joshtriplett commented Dec 5, 2016

upsuper commented Dec 7, 2016

JIghtuse commented Dec 7, 2016

SimonSapin commented Dec 7, 2016

SimonSapin commented Dec 7, 2016

joshtriplett commented Dec 7, 2016

alexcrichton commented Dec 9, 2016

alexcrichton commented Dec 9, 2016

joshtriplett commented Dec 9, 2016 •

edited

Loading

alexcrichton commented Dec 11, 2016

SimonSapin commented Dec 11, 2016

alexcrichton commented Dec 13, 2016

brson commented Dec 29, 2016

alexcrichton commented Dec 29, 2016

brson commented Dec 30, 2016 •

edited

Loading

brson commented Dec 30, 2016

SkylerLipthay commented Dec 31, 2016

brson commented Dec 31, 2016

brson commented Dec 31, 2016

alexcrichton commented Dec 31, 2016

brson commented Jan 5, 2017 •

edited

Loading

alexcrichton commented Jan 6, 2017

alexcrichton commented Jan 12, 2017

abonander commented Mar 12, 2018 •

edited

Loading

alexcrichton commented Mar 12, 2018

abonander commented Mar 12, 2018

OUT_DIR variable not set #3368

OUT_DIR variable not set #3368

Comments

Razican commented Dec 4, 2016

joshtriplett commented Dec 5, 2016

joshtriplett commented Dec 5, 2016

upsuper commented Dec 7, 2016

JIghtuse commented Dec 7, 2016

SimonSapin commented Dec 7, 2016

SimonSapin commented Dec 7, 2016

joshtriplett commented Dec 7, 2016

alexcrichton commented Dec 9, 2016

alexcrichton commented Dec 9, 2016

joshtriplett commented Dec 9, 2016 • edited Loading

alexcrichton commented Dec 11, 2016

SimonSapin commented Dec 11, 2016

alexcrichton commented Dec 13, 2016

brson commented Dec 29, 2016

alexcrichton commented Dec 29, 2016

brson commented Dec 30, 2016 • edited Loading

brson commented Dec 30, 2016

SkylerLipthay commented Dec 31, 2016

brson commented Dec 31, 2016

brson commented Dec 31, 2016

alexcrichton commented Dec 31, 2016

brson commented Jan 5, 2017 • edited Loading

alexcrichton commented Jan 6, 2017

alexcrichton commented Jan 12, 2017

abonander commented Mar 12, 2018 • edited Loading

alexcrichton commented Mar 12, 2018

abonander commented Mar 12, 2018

`OUT_DIR` variable not set #3368

`OUT_DIR` variable not set #3368

joshtriplett commented Dec 9, 2016 •

edited

Loading

brson commented Dec 30, 2016 •

edited

Loading

brson commented Jan 5, 2017 •

edited

Loading

abonander commented Mar 12, 2018 •

edited

Loading