Implemented build.build-dir config option
#15104
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This is in preparation for splitting the intermediate build artifacts from the `target` directory.
This commit adds a `build_dir` option to the `build` table in `config.toml` and adds the equivalent field to `Workspace` and `GlobalContext`.
This commits implements the seperation of the intermidate artifact directory (called "build directory") from the target directory. (see rust-lang#14125)
rustbot
added
A-build-execution
ranger-ross
changed the title
build.build-dir config option
weihanglo
reviewed
Jan 26, 2025
There was a problem hiding this comment.
Just want to make sure I didn't miss something. From what I can tell these directories/files have been removed right?
target/<profile>/.metabuildtarget/<profile>/.fingerprinttarget/<profile>/depstarget/<profile>/incrementaltarget/<profile>/buildtarget/.cargo-locktarget/tmptarget/.rustc_info.json
There was a problem hiding this comment.
We usually add some tests verifying a nightly flag is really gated.
| @@ -290,7 +290,9 @@ impl<'a, 'gctx> BuildRunner<'a, 'gctx> { | |||
| }); | |||
| } | |||
|
|
|||
| super::output_depinfo(&mut self, unit)?; | |||
| if !self.bcx.gctx.cli_unstable().build_dir { | |||
| super::output_depinfo(&mut self, unit)?; | |||
There was a problem hiding this comment.
Why do we stop generating this when build-dir is enabled?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
(still a work in progress)
What does this PR try to resolve?
This PR adds a new
build.build-dirconfiguration option that was proposed in #14125 (comment)This new config option allows the user to specify a directory where intermediate build artifacts should be stored.
I have shortened it to just
build-dirfromtarget-build-dir, although naming is still subject to change.How should we test and review this PR?
This is probably best reviewed commit by commit. I document each commit.
I tied to follow the atomic commits recommendation in the Cargo contributors guide, but I split out some commits for ease of review. (Otherwise I think this would have ended up being 1 or 2 large commits 😅)
Questions
cargo clean?targetand does not impact the build-dir but this is easily changable.cargo packageare was expecting just the.cratefile to be intargetwhile all other output be stored inbuild.build-dir? Not sure if we consider things likeCargo.toml,Cargo.toml.orig,.cargo_vcs_info.jsonpart of the user facing interface.TODO
build.build-dir