Skip to content

Commit c204194

Browse files
authored
docs: Formatting and cross-linking to build-dir/target-dir docs (#15840)
Documentation follow up on #15833 (comment) r? @weihanglo
2 parents 2b71fd6 + e1969ef commit c204194

File tree

2 files changed

+10
-9
lines changed

2 files changed

+10
-9
lines changed

src/doc/src/appendix/glossary.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -188,12 +188,12 @@ The meaning of the term *target* depends on the context:
188188
[list of targets][targets] are configured in the `Cargo.toml`
189189
[*manifest*](#manifest), often inferred automatically by the [directory
190190
layout] of the source files.
191-
- **Target Directory** --- Cargo places all built artifacts and intermediate
192-
files in the *target* directory. By default this is a directory named
193-
`target` at the [*workspace*](#workspace) root, or the package root if not
194-
using a workspace. The directory may be changed with the `--target-dir`
195-
command-line option, the `CARGO_TARGET_DIR` [environment variable], or the
196-
`build.target-dir` [config option].
191+
- **Target Directory** --- Cargo places built artifacts in the *target* directory.
192+
By default this is a directory named `target` at the [*workspace*](#workspace) root,
193+
or the package root if not using a workspace. The directory may be changed with
194+
the `--target-dir` command-line option, the `CARGO_TARGET_DIR` [environment variable],
195+
or the `build.target-dir` [config option].
196+
For more information see the [build cache] documentation.
197197
- **Target Architecture** --- The OS and machine architecture for the built
198198
artifacts are typically referred to as a *target*.
199199
- **Target Triple** --- A triple is a specific format for specifying a target
@@ -251,6 +251,7 @@ manifest is located. (Compare with [*package root*](#package).)
251251
[Directory Sources]: ../reference/source-replacement.md#directory-sources
252252
[Local Registry Sources]: ../reference/source-replacement.md#local-registry-sources
253253
[Source Replacement]: ../reference/source-replacement.md
254+
[build cache]: ../reference/build-cache.html
254255
[cargo-unstable]: ../reference/unstable.md
255256
[config option]: ../reference/config.md
256257
[crates.io]: https://crates.io/

src/doc/src/reference/build-cache.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -70,9 +70,9 @@ change. Some of these directories are:
7070

7171
Directory | Description
7272
----------|------------
73-
<code style="white-space: nowrap">build-dir/debug/deps/</code> | Dependencies and other artifacts.
74-
<code style="white-space: nowrap">build-dir/debug/incremental/</code> | `rustc` [incremental output], a cache used to speed up subsequent builds.
75-
<code style="white-space: nowrap">build-dir/debug/build/</code> | Output from [build scripts].
73+
<code style="white-space: nowrap">\<build-dir>/debug/deps/</code> | Dependencies and other artifacts.
74+
<code style="white-space: nowrap">\<build-dir>/debug/incremental/</code> | `rustc` [incremental output], a cache used to speed up subsequent builds.
75+
<code style="white-space: nowrap">\<build-dir>/debug/build/</code> | Output from [build scripts].
7676

7777
## Dep-info files
7878

0 commit comments

Comments
 (0)