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.

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

docs: Minor re-grouping of pages #14620

Merged
merged 3 commits into from
Oct 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions src/doc/book.toml
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,6 @@ smart-punctuation = true # Enable smart-punctuation feature for more than quotes
git-repository-url = "https://github.com/rust-lang/cargo/tree/master/src/doc/src"
edit-url-template = "https://github.com/rust-lang/cargo/edit/master/src/doc/{path}"
search.use-boolean-and = true

[output.html.redirect]
"/guide/build-cache.html" = "../reference/build-cache.html"
2 changes: 1 addition & 1 deletion src/doc/man/generated_txt/cargo-bench.txt
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,7 @@ OPTIONS
Note that specifying this flag makes Cargo run in a different mode
where the target artifacts are placed in a separate directory. See
the build cache
<https://doc.rust-lang.org/cargo/guide/build-cache.html>
<https://doc.rust-lang.org/cargo/reference/build-cache.html>
documentation for more details.

--profile name
Expand Down
2 changes: 1 addition & 1 deletion src/doc/man/generated_txt/cargo-build.txt
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ OPTIONS
Note that specifying this flag makes Cargo run in a different mode
where the target artifacts are placed in a separate directory. See
the build cache
<https://doc.rust-lang.org/cargo/guide/build-cache.html>
<https://doc.rust-lang.org/cargo/reference/build-cache.html>
documentation for more details.

-r, --release
Expand Down
2 changes: 1 addition & 1 deletion src/doc/man/generated_txt/cargo-check.txt
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ OPTIONS
Note that specifying this flag makes Cargo run in a different mode
where the target artifacts are placed in a separate directory. See
the build cache
<https://doc.rust-lang.org/cargo/guide/build-cache.html>
<https://doc.rust-lang.org/cargo/reference/build-cache.html>
documentation for more details.

-r, --release
Expand Down
2 changes: 1 addition & 1 deletion src/doc/man/generated_txt/cargo-clean.txt
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ OPTIONS
Note that specifying this flag makes Cargo run in a different mode
where the target artifacts are placed in a separate directory. See
the build cache
<https://doc.rust-lang.org/cargo/guide/build-cache.html>
<https://doc.rust-lang.org/cargo/reference/build-cache.html>
documentation for more details.

Display Options
Expand Down
2 changes: 1 addition & 1 deletion src/doc/man/generated_txt/cargo-doc.txt
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ OPTIONS
Note that specifying this flag makes Cargo run in a different mode
where the target artifacts are placed in a separate directory. See
the build cache
<https://doc.rust-lang.org/cargo/guide/build-cache.html>
<https://doc.rust-lang.org/cargo/reference/build-cache.html>
documentation for more details.

-r, --release
Expand Down
2 changes: 1 addition & 1 deletion src/doc/man/generated_txt/cargo-fetch.txt
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ OPTIONS
Note that specifying this flag makes Cargo run in a different mode
where the target artifacts are placed in a separate directory. See
the build cache
<https://doc.rust-lang.org/cargo/guide/build-cache.html>
<https://doc.rust-lang.org/cargo/reference/build-cache.html>
documentation for more details.

Display Options
Expand Down
2 changes: 1 addition & 1 deletion src/doc/man/generated_txt/cargo-fix.txt
Original file line number Diff line number Diff line change
Expand Up @@ -219,7 +219,7 @@ OPTIONS
Note that specifying this flag makes Cargo run in a different mode
where the target artifacts are placed in a separate directory. See
the build cache
<https://doc.rust-lang.org/cargo/guide/build-cache.html>
<https://doc.rust-lang.org/cargo/reference/build-cache.html>
documentation for more details.

-r, --release
Expand Down
2 changes: 1 addition & 1 deletion src/doc/man/generated_txt/cargo-install.txt
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@ OPTIONS
Note that specifying this flag makes Cargo run in a different mode
where the target artifacts are placed in a separate directory. See
the build cache
<https://doc.rust-lang.org/cargo/guide/build-cache.html>
<https://doc.rust-lang.org/cargo/reference/build-cache.html>
documentation for more details.

--target-dir directory
Expand Down
2 changes: 1 addition & 1 deletion src/doc/man/generated_txt/cargo-package.txt
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ OPTIONS
Note that specifying this flag makes Cargo run in a different mode
where the target artifacts are placed in a separate directory. See
the build cache
<https://doc.rust-lang.org/cargo/guide/build-cache.html>
<https://doc.rust-lang.org/cargo/reference/build-cache.html>
documentation for more details.

--target-dir directory
Expand Down
2 changes: 1 addition & 1 deletion src/doc/man/generated_txt/cargo-publish.txt
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ OPTIONS
Note that specifying this flag makes Cargo run in a different mode
where the target artifacts are placed in a separate directory. See
the build cache
<https://doc.rust-lang.org/cargo/guide/build-cache.html>
<https://doc.rust-lang.org/cargo/reference/build-cache.html>
documentation for more details.

--target-dir directory
Expand Down
2 changes: 1 addition & 1 deletion src/doc/man/generated_txt/cargo-run.txt
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ OPTIONS
Note that specifying this flag makes Cargo run in a different mode
where the target artifacts are placed in a separate directory. See
the build cache
<https://doc.rust-lang.org/cargo/guide/build-cache.html>
<https://doc.rust-lang.org/cargo/reference/build-cache.html>
documentation for more details.

-r, --release
Expand Down
2 changes: 1 addition & 1 deletion src/doc/man/generated_txt/cargo-rustc.txt
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ OPTIONS
Note that specifying this flag makes Cargo run in a different mode
where the target artifacts are placed in a separate directory. See
the build cache
<https://doc.rust-lang.org/cargo/guide/build-cache.html>
<https://doc.rust-lang.org/cargo/reference/build-cache.html>
documentation for more details.

-r, --release
Expand Down
2 changes: 1 addition & 1 deletion src/doc/man/generated_txt/cargo-rustdoc.txt
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ OPTIONS
Note that specifying this flag makes Cargo run in a different mode
where the target artifacts are placed in a separate directory. See
the build cache
<https://doc.rust-lang.org/cargo/guide/build-cache.html>
<https://doc.rust-lang.org/cargo/reference/build-cache.html>
documentation for more details.

-r, --release
Expand Down
2 changes: 1 addition & 1 deletion src/doc/man/generated_txt/cargo-test.txt
Original file line number Diff line number Diff line change
Expand Up @@ -254,7 +254,7 @@ OPTIONS
Note that specifying this flag makes Cargo run in a different mode
where the target artifacts are placed in a separate directory. See
the build cache
<https://doc.rust-lang.org/cargo/guide/build-cache.html>
<https://doc.rust-lang.org/cargo/reference/build-cache.html>
documentation for more details.

-r, --release
Expand Down
2 changes: 1 addition & 1 deletion src/doc/man/includes/options-target-triple.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,5 @@ This may also be specified with the `build.target`

Note that specifying this flag makes Cargo run in a different mode where the
target artifacts are placed in a separate directory. See the
[build cache](../guide/build-cache.html) documentation for more details.
[build cache](../reference/build-cache.html) documentation for more details.
{{/option}}
12 changes: 6 additions & 6 deletions src/doc/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,33 +15,33 @@
* [Cargo.toml vs Cargo.lock](guide/cargo-toml-vs-cargo-lock.md)
* [Tests](guide/tests.md)
* [Continuous Integration](guide/continuous-integration.md)
* [Publishing on crates.io](reference/publishing.md)
* [Cargo Home](guide/cargo-home.md)
* [Build Cache](guide/build-cache.md)

* [Cargo Reference](reference/index.md)
* [Specifying Dependencies](reference/specifying-dependencies.md)
* [Overriding Dependencies](reference/overriding-dependencies.md)
* [The Manifest Format](reference/manifest.md)
* [Cargo Targets](reference/cargo-targets.md)
* [Workspaces](reference/workspaces.md)
* [Specifying Dependencies](reference/specifying-dependencies.md)
* [Overriding Dependencies](reference/overriding-dependencies.md)
* [Source Replacement](reference/source-replacement.md)
* [Dependency Resolution](reference/resolver.md)
* [Features](reference/features.md)
* [Features Examples](reference/features-examples.md)
* [Profiles](reference/profiles.md)
* [Configuration](reference/config.md)
* [Environment Variables](reference/environment-variables.md)
* [Build Scripts](reference/build-scripts.md)
* [Build Script Examples](reference/build-script-examples.md)
* [Publishing on crates.io](reference/publishing.md)
* [Build Cache](reference/build-cache.md)
* [Package ID Specifications](reference/pkgid-spec.md)
* [Source Replacement](reference/source-replacement.md)
* [External Tools](reference/external-tools.md)
* [Registries](reference/registries.md)
* [Registry Authentication](reference/registry-authentication.md)
* [Credential Provider Protocol](reference/credential-provider-protocol.md)
* [Running a Registry](reference/running-a-registry.md)
* [Registry Index](reference/registry-index.md)
* [Registry Web API](reference/registry-web-api.md)
* [Dependency Resolution](reference/resolver.md)
* [SemVer Compatibility](reference/semver.md)
* [Future incompat report](reference/future-incompat-report.md)
* [Reporting build timings](reference/timings.md)
Expand Down
2 changes: 1 addition & 1 deletion src/doc/src/commands/cargo-bench.md
Original file line number Diff line number Diff line change
Expand Up @@ -263,7 +263,7 @@ list of supported targets. This flag may be specified multiple times.</p>
<a href="../reference/config.html">config value</a>.</p>
<p>Note that specifying this flag makes Cargo run in a different mode where the
target artifacts are placed in a separate directory. See the
<a href="../guide/build-cache.html">build cache</a> documentation for more details.</dd>
<a href="../reference/build-cache.html">build cache</a> documentation for more details.</dd>


<dt class="option-term" id="option-cargo-bench---profile"><a class="option-anchor" href="#option-cargo-bench---profile"></a><code>--profile</code> <em>name</em></dt>
Expand Down
2 changes: 1 addition & 1 deletion src/doc/src/commands/cargo-build.md
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ list of supported targets. This flag may be specified multiple times.</p>
<a href="../reference/config.html">config value</a>.</p>
<p>Note that specifying this flag makes Cargo run in a different mode where the
target artifacts are placed in a separate directory. See the
<a href="../guide/build-cache.html">build cache</a> documentation for more details.</dd>
<a href="../reference/build-cache.html">build cache</a> documentation for more details.</dd>


<dt class="option-term" id="option-cargo-build--r"><a class="option-anchor" href="#option-cargo-build--r"></a><code>-r</code></dt>
Expand Down
2 changes: 1 addition & 1 deletion src/doc/src/commands/cargo-check.md
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ list of supported targets. This flag may be specified multiple times.</p>
<a href="../reference/config.html">config value</a>.</p>
<p>Note that specifying this flag makes Cargo run in a different mode where the
target artifacts are placed in a separate directory. See the
<a href="../guide/build-cache.html">build cache</a> documentation for more details.</dd>
<a href="../reference/build-cache.html">build cache</a> documentation for more details.</dd>


<dt class="option-term" id="option-cargo-check--r"><a class="option-anchor" href="#option-cargo-check--r"></a><code>-r</code></dt>
Expand Down
2 changes: 1 addition & 1 deletion src/doc/src/commands/cargo-clean.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ list of supported targets. This flag may be specified multiple times.</p>
<a href="../reference/config.html">config value</a>.</p>
<p>Note that specifying this flag makes Cargo run in a different mode where the
target artifacts are placed in a separate directory. See the
<a href="../guide/build-cache.html">build cache</a> documentation for more details.</dd>
<a href="../reference/build-cache.html">build cache</a> documentation for more details.</dd>


</dl>
Expand Down
2 changes: 1 addition & 1 deletion src/doc/src/commands/cargo-doc.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ list of supported targets. This flag may be specified multiple times.</p>
<a href="../reference/config.html">config value</a>.</p>
<p>Note that specifying this flag makes Cargo run in a different mode where the
target artifacts are placed in a separate directory. See the
<a href="../guide/build-cache.html">build cache</a> documentation for more details.</dd>
<a href="../reference/build-cache.html">build cache</a> documentation for more details.</dd>


<dt class="option-term" id="option-cargo-doc--r"><a class="option-anchor" href="#option-cargo-doc--r"></a><code>-r</code></dt>
Expand Down
2 changes: 1 addition & 1 deletion src/doc/src/commands/cargo-fetch.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ list of supported targets. This flag may be specified multiple times.</p>
<a href="../reference/config.html">config value</a>.</p>
<p>Note that specifying this flag makes Cargo run in a different mode where the
target artifacts are placed in a separate directory. See the
<a href="../guide/build-cache.html">build cache</a> documentation for more details.</dd>
<a href="../reference/build-cache.html">build cache</a> documentation for more details.</dd>

</dl>

Expand Down
2 changes: 1 addition & 1 deletion src/doc/src/commands/cargo-fix.md
Original file line number Diff line number Diff line change
Expand Up @@ -254,7 +254,7 @@ list of supported targets. This flag may be specified multiple times.</p>
<a href="../reference/config.html">config value</a>.</p>
<p>Note that specifying this flag makes Cargo run in a different mode where the
target artifacts are placed in a separate directory. See the
<a href="../guide/build-cache.html">build cache</a> documentation for more details.</dd>
<a href="../reference/build-cache.html">build cache</a> documentation for more details.</dd>


<dt class="option-term" id="option-cargo-fix--r"><a class="option-anchor" href="#option-cargo-fix--r"></a><code>-r</code></dt>
Expand Down
2 changes: 1 addition & 1 deletion src/doc/src/commands/cargo-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -219,7 +219,7 @@ list of supported targets.</p>
<a href="../reference/config.html">config value</a>.</p>
<p>Note that specifying this flag makes Cargo run in a different mode where the
target artifacts are placed in a separate directory. See the
<a href="../guide/build-cache.html">build cache</a> documentation for more details.</dd>
<a href="../reference/build-cache.html">build cache</a> documentation for more details.</dd>


<dt class="option-term" id="option-cargo-install---target-dir"><a class="option-anchor" href="#option-cargo-install---target-dir"></a><code>--target-dir</code> <em>directory</em></dt>
Expand Down
2 changes: 1 addition & 1 deletion src/doc/src/commands/cargo-package.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ list of supported targets. This flag may be specified multiple times.</p>
<a href="../reference/config.html">config value</a>.</p>
<p>Note that specifying this flag makes Cargo run in a different mode where the
target artifacts are placed in a separate directory. See the
<a href="../guide/build-cache.html">build cache</a> documentation for more details.</dd>
<a href="../reference/build-cache.html">build cache</a> documentation for more details.</dd>


<dt class="option-term" id="option-cargo-package---target-dir"><a class="option-anchor" href="#option-cargo-package---target-dir"></a><code>--target-dir</code> <em>directory</em></dt>
Expand Down
2 changes: 1 addition & 1 deletion src/doc/src/commands/cargo-publish.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ list of supported targets. This flag may be specified multiple times.</p>
<a href="../reference/config.html">config value</a>.</p>
<p>Note that specifying this flag makes Cargo run in a different mode where the
target artifacts are placed in a separate directory. See the
<a href="../guide/build-cache.html">build cache</a> documentation for more details.</dd>
<a href="../reference/build-cache.html">build cache</a> documentation for more details.</dd>


<dt class="option-term" id="option-cargo-publish---target-dir"><a class="option-anchor" href="#option-cargo-publish---target-dir"></a><code>--target-dir</code> <em>directory</em></dt>
Expand Down
2 changes: 1 addition & 1 deletion src/doc/src/commands/cargo-run.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ list of supported targets.</p>
<a href="../reference/config.html">config value</a>.</p>
<p>Note that specifying this flag makes Cargo run in a different mode where the
target artifacts are placed in a separate directory. See the
<a href="../guide/build-cache.html">build cache</a> documentation for more details.</dd>
<a href="../reference/build-cache.html">build cache</a> documentation for more details.</dd>


<dt class="option-term" id="option-cargo-run--r"><a class="option-anchor" href="#option-cargo-run--r"></a><code>-r</code></dt>
Expand Down
2 changes: 1 addition & 1 deletion src/doc/src/commands/cargo-rustc.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ list of supported targets. This flag may be specified multiple times.</p>
<a href="../reference/config.html">config value</a>.</p>
<p>Note that specifying this flag makes Cargo run in a different mode where the
target artifacts are placed in a separate directory. See the
<a href="../guide/build-cache.html">build cache</a> documentation for more details.</dd>
<a href="../reference/build-cache.html">build cache</a> documentation for more details.</dd>


<dt class="option-term" id="option-cargo-rustc--r"><a class="option-anchor" href="#option-cargo-rustc--r"></a><code>-r</code></dt>
Expand Down
2 changes: 1 addition & 1 deletion src/doc/src/commands/cargo-rustdoc.md
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ list of supported targets. This flag may be specified multiple times.</p>
<a href="../reference/config.html">config value</a>.</p>
<p>Note that specifying this flag makes Cargo run in a different mode where the
target artifacts are placed in a separate directory. See the
<a href="../guide/build-cache.html">build cache</a> documentation for more details.</dd>
<a href="../reference/build-cache.html">build cache</a> documentation for more details.</dd>


<dt class="option-term" id="option-cargo-rustdoc--r"><a class="option-anchor" href="#option-cargo-rustdoc--r"></a><code>-r</code></dt>
Expand Down
2 changes: 1 addition & 1 deletion src/doc/src/commands/cargo-test.md
Original file line number Diff line number Diff line change
Expand Up @@ -285,7 +285,7 @@ list of supported targets. This flag may be specified multiple times.</p>
<a href="../reference/config.html">config value</a>.</p>
<p>Note that specifying this flag makes Cargo run in a different mode where the
target artifacts are placed in a separate directory. See the
<a href="../guide/build-cache.html">build cache</a> documentation for more details.</dd>
<a href="../reference/build-cache.html">build cache</a> documentation for more details.</dd>


<dt class="option-term" id="option-cargo-test--r"><a class="option-anchor" href="#option-cargo-test--r"></a><code>-r</code></dt>
Expand Down
Loading