Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: it's valid to use OUT_DIR for intermediate artifacts #10326

Merged
merged 1 commit into from
Jan 25, 2022
Merged

doc: it's valid to use OUT_DIR for intermediate artifacts #10326

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions src/doc/src/reference/build-scripts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,9 +69,9 @@ the source directory of the build script’s package.

### Outputs of the Build Script

Build scripts may save any output files in the directory specified in the
[`OUT_DIR` environment variable][build-env]. Scripts should not modify any
files outside of that directory.
Build scripts may save any output files or intermediate artifacts in the
directory specified in the [`OUT_DIR` environment variable][build-env]. Scripts
should not modify any files outside of that directory.

Build scripts communicate with Cargo by printing to stdout. Cargo will
interpret each line that starts with `cargo:` as an instruction that will
Expand Down
6 changes: 3 additions & 3 deletions src/doc/src/reference/environment-variables.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -318,9 +318,9 @@ let out_dir = env::var("OUT_DIR").unwrap();
* `CARGO_CFG_TARGET_POINTER_WIDTH=64` — The CPU [pointer width].
* `CARGO_CFG_TARGET_ENDIAN=little` — The CPU [target endianness].
* `CARGO_CFG_TARGET_FEATURE=mmx,sse` — List of CPU [target features] enabled.
* `OUT_DIR` — the folder in which all output should be placed. This folder is
inside the build directory for the package being built, and it is
unique for the package in question.
* `OUT_DIR` — the folder in which all output and intermediate artifacts should
be placed. This folder is inside the build directory for the
package being built, and it is unique for the package in question.
* `TARGET` — the target triple that is being compiled for. Native code should be
compiled for this triple. See the [Target Triple] description
for more information.
Expand Down