Skip to content

Commit d573f78

Browse files
committed
docs(build-dir): Updated documentation for build-dir stabilization
1 parent 4b490ad commit d573f78

File tree

3 files changed

+18
-29
lines changed

3 files changed

+18
-29
lines changed

src/doc/src/reference/config.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -482,6 +482,22 @@ is a directory named `target` located at the root of the workspace.
482482

483483
Can be overridden with the `--target-dir` CLI option.
484484

485+
#### `build.build-dir`
486+
487+
* Type: string (path)
488+
* Default: Defaults to the value of `build.target-dir`
489+
* Environment: `CARGO_BUILD_BUILD_DIR`
490+
491+
The directory where intermediate build artifacts will be stored.
492+
Intermediate artifacts are produced by Rustc/Cargo during the build process.
493+
494+
This option supports path templating.
495+
496+
Available template variables:
497+
* `{workspace-root}` resolves to root of the current workspace.
498+
* `{cargo-cache-home}` resolves to `CARGO_HOME`
499+
* `{workspace-path-hash}` resolves to a hash of the manifest path
500+
485501
#### `build.rustflags`
486502
* Type: string or array of strings
487503
* Default: none

src/doc/src/reference/environment-variables.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,7 @@ In summary, the supported environment variables are:
9595
* `CARGO_BUILD_RUSTDOC` --- The `rustdoc` executable, see [`build.rustdoc`].
9696
* `CARGO_BUILD_TARGET` --- The default target platform, see [`build.target`].
9797
* `CARGO_BUILD_TARGET_DIR` --- The default output directory, see [`build.target-dir`].
98+
* `CARGO_BUILD_BUILD_DIR` --- The default build directory, see [`build.build-dir`].
9899
* `CARGO_BUILD_RUSTFLAGS` --- Extra `rustc` flags, see [`build.rustflags`].
99100
* `CARGO_BUILD_RUSTDOCFLAGS` --- Extra `rustdoc` flags, see [`build.rustdocflags`].
100101
* `CARGO_BUILD_INCREMENTAL` --- Incremental compilation, see [`build.incremental`].
@@ -160,6 +161,7 @@ In summary, the supported environment variables are:
160161
[`build.rustdoc`]: config.md#buildrustdoc
161162
[`build.target`]: config.md#buildtarget
162163
[`build.target-dir`]: config.md#buildtarget-dir
164+
[`build.build-dir`]: config.md#buildbuild-dir
163165
[`build.rustflags`]: config.md#buildrustflags
164166
[`build.rustdocflags`]: config.md#buildrustdocflags
165167
[`build.incremental`]: config.md#buildincremental

src/doc/src/reference/unstable.md

Lines changed: 0 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,6 @@ Each new feature described below should explain how to use it.
8080
* [feature-unification](#feature-unification) --- Enable new feature unification modes in workspaces
8181
* Output behavior
8282
* [artifact-dir](#artifact-dir) --- Adds a directory where artifacts are copied to.
83-
* [build-dir](#build-dir) --- Adds a directory where intermediate build artifacts are stored.
8483
* [Different binary name](#different-binary-name) --- Assign a name to the built binary that is separate from the crate name.
8584
* [root-dir](#root-dir) --- Controls the root directory relative to which paths are printed
8685
* Compile behavior
@@ -247,34 +246,6 @@ This can also be specified in `.cargo/config.toml` files.
247246
artifact-dir = "out"
248247
```
249248

250-
## build-dir
251-
* Original Issue: [#14125](https://github.com/rust-lang/cargo/issues/14125)
252-
* Tracking Issue: [#14125](https://github.com/rust-lang/cargo/issues/14125)
253-
254-
The directory where intermediate build artifacts will be stored.
255-
Intermediate artifacts are produced by Rustc/Cargo during the build process.
256-
257-
```toml
258-
[build]
259-
build-dir = "out"
260-
```
261-
262-
### `build.build-dir`
263-
264-
* Type: string (path)
265-
* Default: Defaults to the value of `build.target-dir`
266-
* Environment: `CARGO_BUILD_BUILD_DIR`
267-
268-
The path to where internal files used as part of the build are placed.
269-
270-
This option supports path templating.
271-
272-
Available template variables:
273-
* `{workspace-root}` resolves to root of the current workspace.
274-
* `{cargo-cache-home}` resolves to `CARGO_HOME`
275-
* `{workspace-path-hash}` resolves to a hash of the manifest path
276-
277-
278249
## root-dir
279250
* Original Issue: [#9887](https://github.com/rust-lang/cargo/issues/9887)
280251
* Tracking Issue: None (not currently slated for stabilization)

0 commit comments

Comments
 (0)