Skip to content

Commit 0473ee8

Browse files
borsbors
committed
Auto merge of #14620 - epage:guideless, r=weihanglo
docs: Minor re-grouping of pages ### What does this PR try to resolve? In figuring out where MSRV documentation should live, I found the location of some items confusing - Publishing is written in more of a guide-form, rather than reference - Caching is written in more of a reference form, rather than a guide, and is more advanced - Dependency references were scattered, making it harder to find ### How should we test and review this PR? ### Additional information
2 parents a06986c + 3a0236f commit 0473ee8

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+165
-161
lines changed

‎src/doc/book.toml

+3
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,6 @@ smart-punctuation = true # Enable smart-punctuation feature for more than quotes
77
git-repository-url = "https://github.com/rust-lang/cargo/tree/master/src/doc/src"
88
edit-url-template = "https://github.com/rust-lang/cargo/edit/master/src/doc/{path}"
99
search.use-boolean-and = true
10+
11+
[output.html.redirect]
12+
"/guide/build-cache.html" = "../reference/build-cache.html"

‎src/doc/man/generated_txt/cargo-bench.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -232,7 +232,7 @@ OPTIONS
232232
Note that specifying this flag makes Cargo run in a different mode
233233
where the target artifacts are placed in a separate directory. See
234234
the build cache
235-
<https://doc.rust-lang.org/cargo/guide/build-cache.html>
235+
<https://doc.rust-lang.org/cargo/reference/build-cache.html>
236236
documentation for more details.
237237

238238
--profile name

‎src/doc/man/generated_txt/cargo-build.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ OPTIONS
149149
Note that specifying this flag makes Cargo run in a different mode
150150
where the target artifacts are placed in a separate directory. See
151151
the build cache
152-
<https://doc.rust-lang.org/cargo/guide/build-cache.html>
152+
<https://doc.rust-lang.org/cargo/reference/build-cache.html>
153153
documentation for more details.
154154

155155
-r, --release

‎src/doc/man/generated_txt/cargo-check.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ OPTIONS
146146
Note that specifying this flag makes Cargo run in a different mode
147147
where the target artifacts are placed in a separate directory. See
148148
the build cache
149-
<https://doc.rust-lang.org/cargo/guide/build-cache.html>
149+
<https://doc.rust-lang.org/cargo/reference/build-cache.html>
150150
documentation for more details.
151151

152152
-r, --release

‎src/doc/man/generated_txt/cargo-clean.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ OPTIONS
5757
Note that specifying this flag makes Cargo run in a different mode
5858
where the target artifacts are placed in a separate directory. See
5959
the build cache
60-
<https://doc.rust-lang.org/cargo/guide/build-cache.html>
60+
<https://doc.rust-lang.org/cargo/reference/build-cache.html>
6161
documentation for more details.
6262

6363
Display Options

‎src/doc/man/generated_txt/cargo-doc.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ OPTIONS
124124
Note that specifying this flag makes Cargo run in a different mode
125125
where the target artifacts are placed in a separate directory. See
126126
the build cache
127-
<https://doc.rust-lang.org/cargo/guide/build-cache.html>
127+
<https://doc.rust-lang.org/cargo/reference/build-cache.html>
128128
documentation for more details.
129129

130130
-r, --release

‎src/doc/man/generated_txt/cargo-fetch.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ OPTIONS
3737
Note that specifying this flag makes Cargo run in a different mode
3838
where the target artifacts are placed in a separate directory. See
3939
the build cache
40-
<https://doc.rust-lang.org/cargo/guide/build-cache.html>
40+
<https://doc.rust-lang.org/cargo/reference/build-cache.html>
4141
documentation for more details.
4242

4343
Display Options

‎src/doc/man/generated_txt/cargo-fix.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@ OPTIONS
219219
Note that specifying this flag makes Cargo run in a different mode
220220
where the target artifacts are placed in a separate directory. See
221221
the build cache
222-
<https://doc.rust-lang.org/cargo/guide/build-cache.html>
222+
<https://doc.rust-lang.org/cargo/reference/build-cache.html>
223223
documentation for more details.
224224

225225
-r, --release

‎src/doc/man/generated_txt/cargo-install.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@ OPTIONS
197197
Note that specifying this flag makes Cargo run in a different mode
198198
where the target artifacts are placed in a separate directory. See
199199
the build cache
200-
<https://doc.rust-lang.org/cargo/guide/build-cache.html>
200+
<https://doc.rust-lang.org/cargo/reference/build-cache.html>
201201
documentation for more details.
202202

203203
--target-dir directory

‎src/doc/man/generated_txt/cargo-package.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ OPTIONS
144144
Note that specifying this flag makes Cargo run in a different mode
145145
where the target artifacts are placed in a separate directory. See
146146
the build cache
147-
<https://doc.rust-lang.org/cargo/guide/build-cache.html>
147+
<https://doc.rust-lang.org/cargo/reference/build-cache.html>
148148
documentation for more details.
149149

150150
--target-dir directory

‎src/doc/man/generated_txt/cargo-publish.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ OPTIONS
9292
Note that specifying this flag makes Cargo run in a different mode
9393
where the target artifacts are placed in a separate directory. See
9494
the build cache
95-
<https://doc.rust-lang.org/cargo/guide/build-cache.html>
95+
<https://doc.rust-lang.org/cargo/reference/build-cache.html>
9696
documentation for more details.
9797

9898
--target-dir directory

‎src/doc/man/generated_txt/cargo-run.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ OPTIONS
7272
Note that specifying this flag makes Cargo run in a different mode
7373
where the target artifacts are placed in a separate directory. See
7474
the build cache
75-
<https://doc.rust-lang.org/cargo/guide/build-cache.html>
75+
<https://doc.rust-lang.org/cargo/reference/build-cache.html>
7676
documentation for more details.
7777

7878
-r, --release

‎src/doc/man/generated_txt/cargo-rustc.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ OPTIONS
140140
Note that specifying this flag makes Cargo run in a different mode
141141
where the target artifacts are placed in a separate directory. See
142142
the build cache
143-
<https://doc.rust-lang.org/cargo/guide/build-cache.html>
143+
<https://doc.rust-lang.org/cargo/reference/build-cache.html>
144144
documentation for more details.
145145

146146
-r, --release

‎src/doc/man/generated_txt/cargo-rustdoc.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ OPTIONS
140140
Note that specifying this flag makes Cargo run in a different mode
141141
where the target artifacts are placed in a separate directory. See
142142
the build cache
143-
<https://doc.rust-lang.org/cargo/guide/build-cache.html>
143+
<https://doc.rust-lang.org/cargo/reference/build-cache.html>
144144
documentation for more details.
145145

146146
-r, --release

‎src/doc/man/generated_txt/cargo-test.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -254,7 +254,7 @@ OPTIONS
254254
Note that specifying this flag makes Cargo run in a different mode
255255
where the target artifacts are placed in a separate directory. See
256256
the build cache
257-
<https://doc.rust-lang.org/cargo/guide/build-cache.html>
257+
<https://doc.rust-lang.org/cargo/reference/build-cache.html>
258258
documentation for more details.
259259

260260
-r, --release

‎src/doc/man/includes/options-target-triple.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,5 @@ This may also be specified with the `build.target`
1212

1313
Note that specifying this flag makes Cargo run in a different mode where the
1414
target artifacts are placed in a separate directory. See the
15-
[build cache](../guide/build-cache.html) documentation for more details.
15+
[build cache](../reference/build-cache.html) documentation for more details.
1616
{{/option}}

‎src/doc/src/SUMMARY.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -15,33 +15,33 @@
1515
* [Cargo.toml vs Cargo.lock](guide/cargo-toml-vs-cargo-lock.md)
1616
* [Tests](guide/tests.md)
1717
* [Continuous Integration](guide/continuous-integration.md)
18+
* [Publishing on crates.io](reference/publishing.md)
1819
* [Cargo Home](guide/cargo-home.md)
19-
* [Build Cache](guide/build-cache.md)
2020

2121
* [Cargo Reference](reference/index.md)
22-
* [Specifying Dependencies](reference/specifying-dependencies.md)
23-
* [Overriding Dependencies](reference/overriding-dependencies.md)
2422
* [The Manifest Format](reference/manifest.md)
2523
* [Cargo Targets](reference/cargo-targets.md)
2624
* [Workspaces](reference/workspaces.md)
25+
* [Specifying Dependencies](reference/specifying-dependencies.md)
26+
* [Overriding Dependencies](reference/overriding-dependencies.md)
27+
* [Source Replacement](reference/source-replacement.md)
28+
* [Dependency Resolution](reference/resolver.md)
2729
* [Features](reference/features.md)
2830
* [Features Examples](reference/features-examples.md)
2931
* [Profiles](reference/profiles.md)
3032
* [Configuration](reference/config.md)
3133
* [Environment Variables](reference/environment-variables.md)
3234
* [Build Scripts](reference/build-scripts.md)
3335
* [Build Script Examples](reference/build-script-examples.md)
34-
* [Publishing on crates.io](reference/publishing.md)
36+
* [Build Cache](reference/build-cache.md)
3537
* [Package ID Specifications](reference/pkgid-spec.md)
36-
* [Source Replacement](reference/source-replacement.md)
3738
* [External Tools](reference/external-tools.md)
3839
* [Registries](reference/registries.md)
3940
* [Registry Authentication](reference/registry-authentication.md)
4041
* [Credential Provider Protocol](reference/credential-provider-protocol.md)
4142
* [Running a Registry](reference/running-a-registry.md)
4243
* [Registry Index](reference/registry-index.md)
4344
* [Registry Web API](reference/registry-web-api.md)
44-
* [Dependency Resolution](reference/resolver.md)
4545
* [SemVer Compatibility](reference/semver.md)
4646
* [Future incompat report](reference/future-incompat-report.md)
4747
* [Reporting build timings](reference/timings.md)

‎src/doc/src/commands/cargo-bench.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -263,7 +263,7 @@ list of supported targets. This flag may be specified multiple times.</p>
263263
<a href="../reference/config.html">config value</a>.</p>
264264
<p>Note that specifying this flag makes Cargo run in a different mode where the
265265
target artifacts are placed in a separate directory. See the
266-
<a href="../guide/build-cache.html">build cache</a> documentation for more details.</dd>
266+
<a href="../reference/build-cache.html">build cache</a> documentation for more details.</dd>
267267

268268

269269
<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>

‎src/doc/src/commands/cargo-build.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,7 @@ list of supported targets. This flag may be specified multiple times.</p>
178178
<a href="../reference/config.html">config value</a>.</p>
179179
<p>Note that specifying this flag makes Cargo run in a different mode where the
180180
target artifacts are placed in a separate directory. See the
181-
<a href="../guide/build-cache.html">build cache</a> documentation for more details.</dd>
181+
<a href="../reference/build-cache.html">build cache</a> documentation for more details.</dd>
182182

183183

184184
<dt class="option-term" id="option-cargo-build--r"><a class="option-anchor" href="#option-cargo-build--r"></a><code>-r</code></dt>

‎src/doc/src/commands/cargo-check.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ list of supported targets. This flag may be specified multiple times.</p>
174174
<a href="../reference/config.html">config value</a>.</p>
175175
<p>Note that specifying this flag makes Cargo run in a different mode where the
176176
target artifacts are placed in a separate directory. See the
177-
<a href="../guide/build-cache.html">build cache</a> documentation for more details.</dd>
177+
<a href="../reference/build-cache.html">build cache</a> documentation for more details.</dd>
178178

179179

180180
<dt class="option-term" id="option-cargo-check--r"><a class="option-anchor" href="#option-cargo-check--r"></a><code>-r</code></dt>

‎src/doc/src/commands/cargo-clean.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ list of supported targets. This flag may be specified multiple times.</p>
6666
<a href="../reference/config.html">config value</a>.</p>
6767
<p>Note that specifying this flag makes Cargo run in a different mode where the
6868
target artifacts are placed in a separate directory. See the
69-
<a href="../guide/build-cache.html">build cache</a> documentation for more details.</dd>
69+
<a href="../reference/build-cache.html">build cache</a> documentation for more details.</dd>
7070

7171

7272
</dl>

‎src/doc/src/commands/cargo-doc.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ list of supported targets. This flag may be specified multiple times.</p>
153153
<a href="../reference/config.html">config value</a>.</p>
154154
<p>Note that specifying this flag makes Cargo run in a different mode where the
155155
target artifacts are placed in a separate directory. See the
156-
<a href="../guide/build-cache.html">build cache</a> documentation for more details.</dd>
156+
<a href="../reference/build-cache.html">build cache</a> documentation for more details.</dd>
157157

158158

159159
<dt class="option-term" id="option-cargo-doc--r"><a class="option-anchor" href="#option-cargo-doc--r"></a><code>-r</code></dt>

‎src/doc/src/commands/cargo-fetch.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ list of supported targets. This flag may be specified multiple times.</p>
3636
<a href="../reference/config.html">config value</a>.</p>
3737
<p>Note that specifying this flag makes Cargo run in a different mode where the
3838
target artifacts are placed in a separate directory. See the
39-
<a href="../guide/build-cache.html">build cache</a> documentation for more details.</dd>
39+
<a href="../reference/build-cache.html">build cache</a> documentation for more details.</dd>
4040

4141
</dl>
4242

‎src/doc/src/commands/cargo-fix.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -254,7 +254,7 @@ list of supported targets. This flag may be specified multiple times.</p>
254254
<a href="../reference/config.html">config value</a>.</p>
255255
<p>Note that specifying this flag makes Cargo run in a different mode where the
256256
target artifacts are placed in a separate directory. See the
257-
<a href="../guide/build-cache.html">build cache</a> documentation for more details.</dd>
257+
<a href="../reference/build-cache.html">build cache</a> documentation for more details.</dd>
258258

259259

260260
<dt class="option-term" id="option-cargo-fix--r"><a class="option-anchor" href="#option-cargo-fix--r"></a><code>-r</code></dt>

‎src/doc/src/commands/cargo-install.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@ list of supported targets.</p>
219219
<a href="../reference/config.html">config value</a>.</p>
220220
<p>Note that specifying this flag makes Cargo run in a different mode where the
221221
target artifacts are placed in a separate directory. See the
222-
<a href="../guide/build-cache.html">build cache</a> documentation for more details.</dd>
222+
<a href="../reference/build-cache.html">build cache</a> documentation for more details.</dd>
223223

224224

225225
<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>

‎src/doc/src/commands/cargo-package.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ list of supported targets. This flag may be specified multiple times.</p>
155155
<a href="../reference/config.html">config value</a>.</p>
156156
<p>Note that specifying this flag makes Cargo run in a different mode where the
157157
target artifacts are placed in a separate directory. See the
158-
<a href="../guide/build-cache.html">build cache</a> documentation for more details.</dd>
158+
<a href="../reference/build-cache.html">build cache</a> documentation for more details.</dd>
159159

160160

161161
<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>

‎src/doc/src/commands/cargo-publish.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ list of supported targets. This flag may be specified multiple times.</p>
102102
<a href="../reference/config.html">config value</a>.</p>
103103
<p>Note that specifying this flag makes Cargo run in a different mode where the
104104
target artifacts are placed in a separate directory. See the
105-
<a href="../guide/build-cache.html">build cache</a> documentation for more details.</dd>
105+
<a href="../reference/build-cache.html">build cache</a> documentation for more details.</dd>
106106

107107

108108
<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>

‎src/doc/src/commands/cargo-run.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ list of supported targets.</p>
9595
<a href="../reference/config.html">config value</a>.</p>
9696
<p>Note that specifying this flag makes Cargo run in a different mode where the
9797
target artifacts are placed in a separate directory. See the
98-
<a href="../guide/build-cache.html">build cache</a> documentation for more details.</dd>
98+
<a href="../reference/build-cache.html">build cache</a> documentation for more details.</dd>
9999

100100

101101
<dt class="option-term" id="option-cargo-run--r"><a class="option-anchor" href="#option-cargo-run--r"></a><code>-r</code></dt>

‎src/doc/src/commands/cargo-rustc.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ list of supported targets. This flag may be specified multiple times.</p>
167167
<a href="../reference/config.html">config value</a>.</p>
168168
<p>Note that specifying this flag makes Cargo run in a different mode where the
169169
target artifacts are placed in a separate directory. See the
170-
<a href="../guide/build-cache.html">build cache</a> documentation for more details.</dd>
170+
<a href="../reference/build-cache.html">build cache</a> documentation for more details.</dd>
171171

172172

173173
<dt class="option-term" id="option-cargo-rustc--r"><a class="option-anchor" href="#option-cargo-rustc--r"></a><code>-r</code></dt>

‎src/doc/src/commands/cargo-rustdoc.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ list of supported targets. This flag may be specified multiple times.</p>
173173
<a href="../reference/config.html">config value</a>.</p>
174174
<p>Note that specifying this flag makes Cargo run in a different mode where the
175175
target artifacts are placed in a separate directory. See the
176-
<a href="../guide/build-cache.html">build cache</a> documentation for more details.</dd>
176+
<a href="../reference/build-cache.html">build cache</a> documentation for more details.</dd>
177177

178178

179179
<dt class="option-term" id="option-cargo-rustdoc--r"><a class="option-anchor" href="#option-cargo-rustdoc--r"></a><code>-r</code></dt>

‎src/doc/src/commands/cargo-test.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -285,7 +285,7 @@ list of supported targets. This flag may be specified multiple times.</p>
285285
<a href="../reference/config.html">config value</a>.</p>
286286
<p>Note that specifying this flag makes Cargo run in a different mode where the
287287
target artifacts are placed in a separate directory. See the
288-
<a href="../guide/build-cache.html">build cache</a> documentation for more details.</dd>
288+
<a href="../reference/build-cache.html">build cache</a> documentation for more details.</dd>
289289

290290

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

0 commit comments

Comments
 (0)