Skip to content

Commit 82061ca

Browse files
committed
Rebuild man pages with fixed <p> tag handling
This rebuilds all the man pages with the fixed mdman `<p>` tag handling to address the broken HTML. This includes a small CSS change to keep the intended rendering.
1 parent f9032ff commit 82061ca

37 files changed

+2110
-1319
lines changed

src/doc/book.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ title = "The Cargo Book"
33
authors = ["Alex Crichton", "Steve Klabnik", "Carol Nichols", "with contributions from the Rust community"]
44

55
[output.html]
6+
additional-css = ["theme/cargo.css"]
67
smart-punctuation = true # Enable smart-punctuation feature for more than quotes.
78
git-repository-url = "https://github.com/rust-lang/cargo/tree/master/src/doc/src"
89
edit-url-template = "https://github.com/rust-lang/cargo/edit/master/src/doc/{path}"

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

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

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

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

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

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

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

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

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

Lines changed: 55 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,9 @@ workspace are cleaned.
2424
<dl>
2525
<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>
2626
<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>
27-
<dd class="option-desc">Clean only the specified packages. This flag may be specified
28-
multiple times. See <a href="cargo-pkgid.html">cargo-pkgid(1)</a> for the SPEC format.</dd>
27+
<dd class="option-desc"><p>Clean only the specified packages. This flag may be specified
28+
multiple times. See <a href="cargo-pkgid.html">cargo-pkgid(1)</a> for the SPEC format.</p>
29+
</dd>
2930

3031
</dl>
3132

@@ -34,32 +35,37 @@ multiple times. See <a href="cargo-pkgid.html">cargo-pkgid(1)</a> for the SPEC f
3435
<dl>
3536

3637
<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-
<dd class="option-desc">Displays a summary of what would be deleted without deleting anything.
38-
Use with <code>--verbose</code> to display the actual files that would be deleted.</dd>
38+
<dd class="option-desc"><p>Displays a summary of what would be deleted without deleting anything.
39+
Use with <code>--verbose</code> to display the actual files that would be deleted.</p>
40+
</dd>
3941

4042

4143
<dt class="option-term" id="option-cargo-clean---doc"><a class="option-anchor" href="#option-cargo-clean---doc"></a><code>--doc</code></dt>
42-
<dd class="option-desc">This option will cause <code>cargo clean</code> to remove only the <code>doc</code> directory in
43-
the target directory.</dd>
44+
<dd class="option-desc"><p>This option will cause <code>cargo clean</code> to remove only the <code>doc</code> directory in
45+
the target directory.</p>
46+
</dd>
4447

4548

4649
<dt class="option-term" id="option-cargo-clean---release"><a class="option-anchor" href="#option-cargo-clean---release"></a><code>--release</code></dt>
47-
<dd class="option-desc">Remove all artifacts in the <code>release</code> directory.</dd>
50+
<dd class="option-desc"><p>Remove all artifacts in the <code>release</code> directory.</p>
51+
</dd>
4852

4953

5054
<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>
51-
<dd class="option-desc">Remove all artifacts in the directory with the given profile name.</dd>
55+
<dd class="option-desc"><p>Remove all artifacts in the directory with the given profile name.</p>
56+
</dd>
5257

5358

5459
<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>
55-
<dd class="option-desc">Directory for all generated artifacts and intermediate files. May also be
60+
<dd class="option-desc"><p>Directory for all generated artifacts and intermediate files. May also be
5661
specified with the <code>CARGO_TARGET_DIR</code> environment variable, or the
5762
<code>build.target-dir</code> <a href="../reference/config.html">config value</a>.
58-
Defaults to <code>target</code> in the root of the workspace.</dd>
63+
Defaults to <code>target</code> in the root of the workspace.</p>
64+
</dd>
5965

6066

6167
<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>
62-
<dd class="option-desc">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
68+
<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
6369
<code>&lt;arch&gt;&lt;sub&gt;-&lt;vendor&gt;-&lt;sys&gt;-&lt;abi&gt;</code>.</p>
6470
<p>Possible values:</p>
6571
<ul>
@@ -70,7 +76,8 @@ Defaults to <code>target</code> in the root of the workspace.</dd>
7076
<p>This may also be specified with the <code>build.target</code> <a href="../reference/config.html">config value</a>.</p>
7177
<p>Note that specifying this flag makes Cargo run in a different mode where the
7278
target artifacts are placed in a separate directory. See the
73-
<a href="../reference/build-cache.html">build cache</a> documentation for more details.</dd>
79+
<a href="../reference/build-cache.html">build cache</a> documentation for more details.</p>
80+
</dd>
7481

7582

7683
</dl>
@@ -80,54 +87,59 @@ target artifacts are placed in a separate directory. See the
8087
<dl>
8188
<dt class="option-term" id="option-cargo-clean--v"><a class="option-anchor" href="#option-cargo-clean--v"></a><code>-v</code></dt>
8289
<dt class="option-term" id="option-cargo-clean---verbose"><a class="option-anchor" href="#option-cargo-clean---verbose"></a><code>--verbose</code></dt>
83-
<dd class="option-desc">Use verbose output. May be specified twice for “very verbose” output which
90+
<dd class="option-desc"><p>Use verbose output. May be specified twice for “very verbose” output which
8491
includes extra output such as dependency warnings and build script output.
8592
May also be specified with the <code>term.verbose</code>
86-
<a href="../reference/config.html">config value</a>.</dd>
93+
<a href="../reference/config.html">config value</a>.</p>
94+
</dd>
8795

8896

8997
<dt class="option-term" id="option-cargo-clean--q"><a class="option-anchor" href="#option-cargo-clean--q"></a><code>-q</code></dt>
9098
<dt class="option-term" id="option-cargo-clean---quiet"><a class="option-anchor" href="#option-cargo-clean---quiet"></a><code>--quiet</code></dt>
91-
<dd class="option-desc">Do not print cargo log messages.
99+
<dd class="option-desc"><p>Do not print cargo log messages.
92100
May also be specified with the <code>term.quiet</code>
93-
<a href="../reference/config.html">config value</a>.</dd>
101+
<a href="../reference/config.html">config value</a>.</p>
102+
</dd>
94103

95104

96105
<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>
97-
<dd class="option-desc">Control when colored output is used. Valid values:</p>
106+
<dd class="option-desc"><p>Control when colored output is used. Valid values:</p>
98107
<ul>
99108
<li><code>auto</code> (default): Automatically detect if color support is available on the
100109
terminal.</li>
101110
<li><code>always</code>: Always display colors.</li>
102111
<li><code>never</code>: Never display colors.</li>
103112
</ul>
104113
<p>May also be specified with the <code>term.color</code>
105-
<a href="../reference/config.html">config value</a>.</dd>
114+
<a href="../reference/config.html">config value</a>.</p>
115+
</dd>
106116

107117
</dl>
108118

109119
### Manifest Options
110120

111121
<dl>
112122
<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>
113-
<dd class="option-desc">Path to the <code>Cargo.toml</code> file. By default, Cargo searches for the
114-
<code>Cargo.toml</code> file in the current directory or any parent directory.</dd>
123+
<dd class="option-desc"><p>Path to the <code>Cargo.toml</code> file. By default, Cargo searches for the
124+
<code>Cargo.toml</code> file in the current directory or any parent directory.</p>
125+
</dd>
115126

116127

117128
<dt class="option-term" id="option-cargo-clean---locked"><a class="option-anchor" href="#option-cargo-clean---locked"></a><code>--locked</code></dt>
118-
<dd class="option-desc">Asserts that the exact same dependencies and versions are used as when the
129+
<dd class="option-desc"><p>Asserts that the exact same dependencies and versions are used as when the
119130
existing <code>Cargo.lock</code> file was originally generated. Cargo will exit with an
120131
error when either of the following scenarios arises:</p>
121132
<ul>
122133
<li>The lock file is missing.</li>
123134
<li>Cargo attempted to change the lock file due to a different dependency resolution.</li>
124135
</ul>
125136
<p>It may be used in environments where deterministic builds are desired,
126-
such as in CI pipelines.</dd>
137+
such as in CI pipelines.</p>
138+
</dd>
127139

128140

129141
<dt class="option-term" id="option-cargo-clean---offline"><a class="option-anchor" href="#option-cargo-clean---offline"></a><code>--offline</code></dt>
130-
<dd class="option-desc">Prevents Cargo from accessing the network for any reason. Without this
142+
<dd class="option-desc"><p>Prevents Cargo from accessing the network for any reason. Without this
131143
flag, Cargo will stop with an error if it needs to access the network and
132144
the network is not available. With this flag, Cargo will attempt to
133145
proceed without the network if possible.</p>
@@ -136,23 +148,26 @@ mode. Cargo will restrict itself to crates that are downloaded locally, even
136148
if there might be a newer version as indicated in the local copy of the index.
137149
See the <a href="cargo-fetch.html">cargo-fetch(1)</a> command to download dependencies before going
138150
offline.</p>
139-
<p>May also be specified with the <code>net.offline</code> <a href="../reference/config.html">config value</a>.</dd>
151+
<p>May also be specified with the <code>net.offline</code> <a href="../reference/config.html">config value</a>.</p>
152+
</dd>
140153

141154

142155
<dt class="option-term" id="option-cargo-clean---frozen"><a class="option-anchor" href="#option-cargo-clean---frozen"></a><code>--frozen</code></dt>
143-
<dd class="option-desc">Equivalent to specifying both <code>--locked</code> and <code>--offline</code>.</dd>
156+
<dd class="option-desc"><p>Equivalent to specifying both <code>--locked</code> and <code>--offline</code>.</p>
157+
</dd>
144158

145159

146160
<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>
147-
<dd class="option-desc">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
161+
<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
148162
<code>Cargo.lock</code> (e.g. <code>--lockfile-path /tmp/temporary-lockfile/Cargo.lock</code>). Note that providing
149163
<code>--lockfile-path</code> will ignore existing lockfile at the default path, and instead will
150164
either use the lockfile from <em>PATH</em>, or write a new lockfile into the provided <em>PATH</em> if it doesn’t exist.
151165
This flag can be used to run most commands in read-only directories, writing lockfile into the provided <em>PATH</em>.</p>
152166
<p>This option is only available on the <a href="https://doc.rust-lang.org/book/appendix-07-nightly-rust.html">nightly
153167
channel</a> and
154168
requires the <code>-Z unstable-options</code> flag to enable (see
155-
<a href="https://github.com/rust-lang/cargo/issues/14421">#14421</a>).</dd>
169+
<a href="https://github.com/rust-lang/cargo/issues/14421">#14421</a>).</p>
170+
</dd>
156171

157172
</dl>
158173

@@ -161,37 +176,42 @@ requires the <code>-Z unstable-options</code> flag to enable (see
161176
<dl>
162177

163178
<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>
164-
<dd class="option-desc">If Cargo has been installed with rustup, and the first argument to <code>cargo</code>
179+
<dd class="option-desc"><p>If Cargo has been installed with rustup, and the first argument to <code>cargo</code>
165180
begins with <code>+</code>, it will be interpreted as a rustup toolchain name (such
166181
as <code>+stable</code> or <code>+nightly</code>).
167182
See the <a href="https://rust-lang.github.io/rustup/overrides.html">rustup documentation</a>
168-
for more information about how toolchain overrides work.</dd>
183+
for more information about how toolchain overrides work.</p>
184+
</dd>
169185

170186

171187
<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>
172-
<dd class="option-desc">Overrides a Cargo configuration value. The argument should be in TOML syntax of <code>KEY=VALUE</code>,
188+
<dd class="option-desc"><p>Overrides a Cargo configuration value. The argument should be in TOML syntax of <code>KEY=VALUE</code>,
173189
or provided as a path to an extra configuration file. This flag may be specified multiple times.
174-
See the <a href="../reference/config.html#command-line-overrides">command-line overrides section</a> for more information.</dd>
190+
See the <a href="../reference/config.html#command-line-overrides">command-line overrides section</a> for more information.</p>
191+
</dd>
175192

176193

177194
<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>
178-
<dd class="option-desc">Changes the current working directory before executing any specified operations. This affects
195+
<dd class="option-desc"><p>Changes the current working directory before executing any specified operations. This affects
179196
things like where cargo looks by default for the project manifest (<code>Cargo.toml</code>), as well as
180197
the directories searched for discovering <code>.cargo/config.toml</code>, for example. This option must
181198
appear before the command name, for example <code>cargo -C path/to/my-project build</code>.</p>
182199
<p>This option is only available on the <a href="https://doc.rust-lang.org/book/appendix-07-nightly-rust.html">nightly
183200
channel</a> and
184201
requires the <code>-Z unstable-options</code> flag to enable (see
185-
<a href="https://github.com/rust-lang/cargo/issues/10098">#10098</a>).</dd>
202+
<a href="https://github.com/rust-lang/cargo/issues/10098">#10098</a>).</p>
203+
</dd>
186204

187205

188206
<dt class="option-term" id="option-cargo-clean--h"><a class="option-anchor" href="#option-cargo-clean--h"></a><code>-h</code></dt>
189207
<dt class="option-term" id="option-cargo-clean---help"><a class="option-anchor" href="#option-cargo-clean---help"></a><code>--help</code></dt>
190-
<dd class="option-desc">Prints help information.</dd>
208+
<dd class="option-desc"><p>Prints help information.</p>
209+
</dd>
191210

192211

193212
<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>
194-
<dd class="option-desc">Unstable (nightly-only) flags to Cargo. Run <code>cargo -Z help</code> for details.</dd>
213+
<dd class="option-desc"><p>Unstable (nightly-only) flags to Cargo. Run <code>cargo -Z help</code> for details.</p>
214+
</dd>
195215

196216

197217
</dl>

0 commit comments

Comments
 (0)