Skip to content

Commit 7f673e8

Browse files
committed
Rebuild man pages with option link fix
This rebuilds the man pages with the correct `</a>` tag placement for options. This also includes some CSS to keep the same color as before.
1 parent c0867de commit 7f673e8

36 files changed

+958
-953
lines changed

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

Lines changed: 39 additions & 39 deletions
Large diffs are not rendered by default.

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

Lines changed: 45 additions & 45 deletions
Large diffs are not rendered by default.

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

Lines changed: 49 additions & 49 deletions
Large diffs are not rendered by default.

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

Lines changed: 47 additions & 47 deletions
Large diffs are not rendered by default.

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

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ When no packages are selected, all packages and all dependencies in the
2222
workspace are cleaned.
2323

2424
<dl>
25-
<dt class="option-term" id="option-cargo-clean--p"><a class="option-anchor" href="#option-cargo-clean--p"></a><code>-p</code> <em>spec</em>…</dt>
26-
<dt class="option-term" id="option-cargo-clean---package"><a class="option-anchor" href="#option-cargo-clean---package"></a><code>--package</code> <em>spec</em>…</dt>
25+
<dt class="option-term" id="option-cargo-clean--p"><a class="option-anchor" href="#option-cargo-clean--p"><code>-p</code> <em>spec</em>…</a></dt>
26+
<dt class="option-term" id="option-cargo-clean---package"><a class="option-anchor" href="#option-cargo-clean---package"><code>--package</code> <em>spec</em>…</a></dt>
2727
<dd class="option-desc"><p>Clean only the specified packages. This flag may be specified
2828
multiple times. See <a href="cargo-pkgid.html">cargo-pkgid(1)</a> for the SPEC format.</p>
2929
</dd>
@@ -34,37 +34,37 @@ multiple times. See <a href="cargo-pkgid.html">cargo-pkgid(1)</a> for the SPEC f
3434

3535
<dl>
3636

37-
<dt class="option-term" id="option-cargo-clean---dry-run"><a class="option-anchor" href="#option-cargo-clean---dry-run"></a><code>--dry-run</code></dt>
37+
<dt class="option-term" id="option-cargo-clean---dry-run"><a class="option-anchor" href="#option-cargo-clean---dry-run"><code>--dry-run</code></a></dt>
3838
<dd class="option-desc"><p>Displays a summary of what would be deleted without deleting anything.
3939
Use with <code>--verbose</code> to display the actual files that would be deleted.</p>
4040
</dd>
4141

4242

43-
<dt class="option-term" id="option-cargo-clean---doc"><a class="option-anchor" href="#option-cargo-clean---doc"></a><code>--doc</code></dt>
43+
<dt class="option-term" id="option-cargo-clean---doc"><a class="option-anchor" href="#option-cargo-clean---doc"><code>--doc</code></a></dt>
4444
<dd class="option-desc"><p>This option will cause <code>cargo clean</code> to remove only the <code>doc</code> directory in
4545
the target directory.</p>
4646
</dd>
4747

4848

49-
<dt class="option-term" id="option-cargo-clean---release"><a class="option-anchor" href="#option-cargo-clean---release"></a><code>--release</code></dt>
49+
<dt class="option-term" id="option-cargo-clean---release"><a class="option-anchor" href="#option-cargo-clean---release"><code>--release</code></a></dt>
5050
<dd class="option-desc"><p>Remove all artifacts in the <code>release</code> directory.</p>
5151
</dd>
5252

5353

54-
<dt class="option-term" id="option-cargo-clean---profile"><a class="option-anchor" href="#option-cargo-clean---profile"></a><code>--profile</code> <em>name</em></dt>
54+
<dt class="option-term" id="option-cargo-clean---profile"><a class="option-anchor" href="#option-cargo-clean---profile"><code>--profile</code> <em>name</em></a></dt>
5555
<dd class="option-desc"><p>Remove all artifacts in the directory with the given profile name.</p>
5656
</dd>
5757

5858

59-
<dt class="option-term" id="option-cargo-clean---target-dir"><a class="option-anchor" href="#option-cargo-clean---target-dir"></a><code>--target-dir</code> <em>directory</em></dt>
59+
<dt class="option-term" id="option-cargo-clean---target-dir"><a class="option-anchor" href="#option-cargo-clean---target-dir"><code>--target-dir</code> <em>directory</em></a></dt>
6060
<dd class="option-desc"><p>Directory for all generated artifacts and intermediate files. May also be
6161
specified with the <code>CARGO_TARGET_DIR</code> environment variable, or the
6262
<code>build.target-dir</code> <a href="../reference/config.html">config value</a>.
6363
Defaults to <code>target</code> in the root of the workspace.</p>
6464
</dd>
6565

6666

67-
<dt class="option-term" id="option-cargo-clean---target"><a class="option-anchor" href="#option-cargo-clean---target"></a><code>--target</code> <em>triple</em></dt>
67+
<dt class="option-term" id="option-cargo-clean---target"><a class="option-anchor" href="#option-cargo-clean---target"><code>--target</code> <em>triple</em></a></dt>
6868
<dd class="option-desc"><p>Clean for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the triple is
6969
<code>&lt;arch&gt;&lt;sub&gt;-&lt;vendor&gt;-&lt;sys&gt;-&lt;abi&gt;</code>.</p>
7070
<p>Possible values:</p>
@@ -85,24 +85,24 @@ target artifacts are placed in a separate directory. See the
8585
### Display Options
8686

8787
<dl>
88-
<dt class="option-term" id="option-cargo-clean--v"><a class="option-anchor" href="#option-cargo-clean--v"></a><code>-v</code></dt>
89-
<dt class="option-term" id="option-cargo-clean---verbose"><a class="option-anchor" href="#option-cargo-clean---verbose"></a><code>--verbose</code></dt>
88+
<dt class="option-term" id="option-cargo-clean--v"><a class="option-anchor" href="#option-cargo-clean--v"><code>-v</code></a></dt>
89+
<dt class="option-term" id="option-cargo-clean---verbose"><a class="option-anchor" href="#option-cargo-clean---verbose"><code>--verbose</code></a></dt>
9090
<dd class="option-desc"><p>Use verbose output. May be specified twice for “very verbose” output which
9191
includes extra output such as dependency warnings and build script output.
9292
May also be specified with the <code>term.verbose</code>
9393
<a href="../reference/config.html">config value</a>.</p>
9494
</dd>
9595

9696

97-
<dt class="option-term" id="option-cargo-clean--q"><a class="option-anchor" href="#option-cargo-clean--q"></a><code>-q</code></dt>
98-
<dt class="option-term" id="option-cargo-clean---quiet"><a class="option-anchor" href="#option-cargo-clean---quiet"></a><code>--quiet</code></dt>
97+
<dt class="option-term" id="option-cargo-clean--q"><a class="option-anchor" href="#option-cargo-clean--q"><code>-q</code></a></dt>
98+
<dt class="option-term" id="option-cargo-clean---quiet"><a class="option-anchor" href="#option-cargo-clean---quiet"><code>--quiet</code></a></dt>
9999
<dd class="option-desc"><p>Do not print cargo log messages.
100100
May also be specified with the <code>term.quiet</code>
101101
<a href="../reference/config.html">config value</a>.</p>
102102
</dd>
103103

104104

105-
<dt class="option-term" id="option-cargo-clean---color"><a class="option-anchor" href="#option-cargo-clean---color"></a><code>--color</code> <em>when</em></dt>
105+
<dt class="option-term" id="option-cargo-clean---color"><a class="option-anchor" href="#option-cargo-clean---color"><code>--color</code> <em>when</em></a></dt>
106106
<dd class="option-desc"><p>Control when colored output is used. Valid values:</p>
107107
<ul>
108108
<li><code>auto</code> (default): Automatically detect if color support is available on the
@@ -119,13 +119,13 @@ terminal.</li>
119119
### Manifest Options
120120

121121
<dl>
122-
<dt class="option-term" id="option-cargo-clean---manifest-path"><a class="option-anchor" href="#option-cargo-clean---manifest-path"></a><code>--manifest-path</code> <em>path</em></dt>
122+
<dt class="option-term" id="option-cargo-clean---manifest-path"><a class="option-anchor" href="#option-cargo-clean---manifest-path"><code>--manifest-path</code> <em>path</em></a></dt>
123123
<dd class="option-desc"><p>Path to the <code>Cargo.toml</code> file. By default, Cargo searches for the
124124
<code>Cargo.toml</code> file in the current directory or any parent directory.</p>
125125
</dd>
126126

127127

128-
<dt class="option-term" id="option-cargo-clean---locked"><a class="option-anchor" href="#option-cargo-clean---locked"></a><code>--locked</code></dt>
128+
<dt class="option-term" id="option-cargo-clean---locked"><a class="option-anchor" href="#option-cargo-clean---locked"><code>--locked</code></a></dt>
129129
<dd class="option-desc"><p>Asserts that the exact same dependencies and versions are used as when the
130130
existing <code>Cargo.lock</code> file was originally generated. Cargo will exit with an
131131
error when either of the following scenarios arises:</p>
@@ -138,7 +138,7 @@ such as in CI pipelines.</p>
138138
</dd>
139139

140140

141-
<dt class="option-term" id="option-cargo-clean---offline"><a class="option-anchor" href="#option-cargo-clean---offline"></a><code>--offline</code></dt>
141+
<dt class="option-term" id="option-cargo-clean---offline"><a class="option-anchor" href="#option-cargo-clean---offline"><code>--offline</code></a></dt>
142142
<dd class="option-desc"><p>Prevents Cargo from accessing the network for any reason. Without this
143143
flag, Cargo will stop with an error if it needs to access the network and
144144
the network is not available. With this flag, Cargo will attempt to
@@ -152,12 +152,12 @@ offline.</p>
152152
</dd>
153153

154154

155-
<dt class="option-term" id="option-cargo-clean---frozen"><a class="option-anchor" href="#option-cargo-clean---frozen"></a><code>--frozen</code></dt>
155+
<dt class="option-term" id="option-cargo-clean---frozen"><a class="option-anchor" href="#option-cargo-clean---frozen"><code>--frozen</code></a></dt>
156156
<dd class="option-desc"><p>Equivalent to specifying both <code>--locked</code> and <code>--offline</code>.</p>
157157
</dd>
158158

159159

160-
<dt class="option-term" id="option-cargo-clean---lockfile-path"><a class="option-anchor" href="#option-cargo-clean---lockfile-path"></a><code>--lockfile-path</code> <em>PATH</em></dt>
160+
<dt class="option-term" id="option-cargo-clean---lockfile-path"><a class="option-anchor" href="#option-cargo-clean---lockfile-path"><code>--lockfile-path</code> <em>PATH</em></a></dt>
161161
<dd class="option-desc"><p>Changes the path of the lockfile from the default (<code>&lt;workspace_root&gt;/Cargo.lock</code>) to <em>PATH</em>. <em>PATH</em> must end with
162162
<code>Cargo.lock</code> (e.g. <code>--lockfile-path /tmp/temporary-lockfile/Cargo.lock</code>). Note that providing
163163
<code>--lockfile-path</code> will ignore existing lockfile at the default path, and instead will
@@ -175,7 +175,7 @@ requires the <code>-Z unstable-options</code> flag to enable (see
175175

176176
<dl>
177177

178-
<dt class="option-term" id="option-cargo-clean-+toolchain"><a class="option-anchor" href="#option-cargo-clean-+toolchain"></a><code>+</code><em>toolchain</em></dt>
178+
<dt class="option-term" id="option-cargo-clean-+toolchain"><a class="option-anchor" href="#option-cargo-clean-+toolchain"><code>+</code><em>toolchain</em></a></dt>
179179
<dd class="option-desc"><p>If Cargo has been installed with rustup, and the first argument to <code>cargo</code>
180180
begins with <code>+</code>, it will be interpreted as a rustup toolchain name (such
181181
as <code>+stable</code> or <code>+nightly</code>).
@@ -184,14 +184,14 @@ for more information about how toolchain overrides work.</p>
184184
</dd>
185185

186186

187-
<dt class="option-term" id="option-cargo-clean---config"><a class="option-anchor" href="#option-cargo-clean---config"></a><code>--config</code> <em>KEY=VALUE</em> or <em>PATH</em></dt>
187+
<dt class="option-term" id="option-cargo-clean---config"><a class="option-anchor" href="#option-cargo-clean---config"><code>--config</code> <em>KEY=VALUE</em> or <em>PATH</em></a></dt>
188188
<dd class="option-desc"><p>Overrides a Cargo configuration value. The argument should be in TOML syntax of <code>KEY=VALUE</code>,
189189
or provided as a path to an extra configuration file. This flag may be specified multiple times.
190190
See the <a href="../reference/config.html#command-line-overrides">command-line overrides section</a> for more information.</p>
191191
</dd>
192192

193193

194-
<dt class="option-term" id="option-cargo-clean--C"><a class="option-anchor" href="#option-cargo-clean--C"></a><code>-C</code> <em>PATH</em></dt>
194+
<dt class="option-term" id="option-cargo-clean--C"><a class="option-anchor" href="#option-cargo-clean--C"><code>-C</code> <em>PATH</em></a></dt>
195195
<dd class="option-desc"><p>Changes the current working directory before executing any specified operations. This affects
196196
things like where cargo looks by default for the project manifest (<code>Cargo.toml</code>), as well as
197197
the directories searched for discovering <code>.cargo/config.toml</code>, for example. This option must
@@ -203,13 +203,13 @@ requires the <code>-Z unstable-options</code> flag to enable (see
203203
</dd>
204204

205205

206-
<dt class="option-term" id="option-cargo-clean--h"><a class="option-anchor" href="#option-cargo-clean--h"></a><code>-h</code></dt>
207-
<dt class="option-term" id="option-cargo-clean---help"><a class="option-anchor" href="#option-cargo-clean---help"></a><code>--help</code></dt>
206+
<dt class="option-term" id="option-cargo-clean--h"><a class="option-anchor" href="#option-cargo-clean--h"><code>-h</code></a></dt>
207+
<dt class="option-term" id="option-cargo-clean---help"><a class="option-anchor" href="#option-cargo-clean---help"><code>--help</code></a></dt>
208208
<dd class="option-desc"><p>Prints help information.</p>
209209
</dd>
210210

211211

212-
<dt class="option-term" id="option-cargo-clean--Z"><a class="option-anchor" href="#option-cargo-clean--Z"></a><code>-Z</code> <em>flag</em></dt>
212+
<dt class="option-term" id="option-cargo-clean--Z"><a class="option-anchor" href="#option-cargo-clean--Z"><code>-Z</code> <em>flag</em></a></dt>
213213
<dd class="option-desc"><p>Unstable (nightly-only) flags to Cargo. Run <code>cargo -Z help</code> for details.</p>
214214
</dd>
215215

0 commit comments

Comments
 (0)