Skip to content

Commit ece5269

Browse files
dtolnaydtolnay
committed
Stabilize --keep-going
1 parent 88d4d94 commit ece5269

Some content is hidden

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

52 files changed

+293
-115
lines changed

‎src/cargo/util/command_prelude.rs

+1-6
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ pub trait CommandExt: Sized {
8787
self.arg_jobs()._arg(
8888
flag(
8989
"keep-going",
90-
"Do not abort the build as soon as there is an error (unstable)",
90+
"Do not abort the build as soon as there is an error",
9191
)
9292
.help_heading(heading::COMPILATION_OPTIONS),
9393
)
@@ -627,11 +627,6 @@ pub trait ArgMatchesExt {
627627
}
628628
}
629629

630-
if build_config.keep_going {
631-
config
632-
.cli_unstable()
633-
.fail_if_stable_opt("--keep-going", 10496)?;
634-
}
635630
if build_config.build_plan {
636631
config
637632
.cli_unstable()

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

+8-1
Original file line numberDiff line numberDiff line change
@@ -158,9 +158,16 @@ Rust test harness runs benchmarks serially in a single thread.
158158

159159
{{#options}}
160160
{{> options-jobs }}
161-
{{> options-keep-going }}
162161
{{/options}}
163162

163+
While `cargo bench` involves compilation, it does not provide a `--keep-going`
164+
flag. Use `--no-fail-fast` to run as many benchmarks as possible without
165+
stopping at the first failure. To "compile" as many benchmarks as possible, use
166+
`--benches` to build benchmark binaries separately. For example:
167+
168+
cargo build --benches --release --keep-going
169+
cargo bench --no-fail-fast
170+
164171
{{> section-environment }}
165172

166173
{{> section-exit-status }}

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

+8
Original file line numberDiff line numberDiff line change
@@ -191,6 +191,14 @@ includes an option to control the number of threads used:
191191

192192
{{/options}}
193193

194+
While `cargo test` involves compilation, it does not provide a `--keep-going`
195+
flag. Use `--no-fail-fast` to run as many tests as possible without stopping at
196+
the first failure. To "compile" as many tests as possible, use `--tests` to
197+
build test binaries separately. For example:
198+
199+
cargo build --tests --keep-going
200+
cargo test --tests --no-fail-fast
201+
194202
{{> section-environment }}
195203

196204
{{> section-exit-status }}

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

+8-4
Original file line numberDiff line numberDiff line change
@@ -413,10 +413,14 @@ OPTIONS
413413
If a string default is provided, it sets the value back to defaults.
414414
Should not be 0.
415415

416-
--keep-going
417-
Build as many crates in the dependency graph as possible, rather
418-
than aborting the build on the first one that fails to build.
419-
Unstable, requires -Zunstable-options.
416+
While cargo bench involves compilation, it does not provide a
417+
--keep-going flag. Use --no-fail-fast to run as many benchmarks as
418+
possible without stopping at the first failure. To “compile” as many
419+
benchmarks as possible, use --benches to build benchmark binaries
420+
separately. For example:
421+
422+
cargo build --benches --release --keep-going
423+
cargo bench --no-fail-fast
420424

421425
ENVIRONMENT
422426
See the reference

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

+7-1
Original file line numberDiff line numberDiff line change
@@ -347,7 +347,13 @@ OPTIONS
347347
--keep-going
348348
Build as many crates in the dependency graph as possible, rather
349349
than aborting the build on the first one that fails to build.
350-
Unstable, requires -Zunstable-options.
350+
351+
For example if the current package depends on dependencies fails and
352+
works, one of which fails to build, cargo build -j1 may or may not
353+
build the one that succeeds (depending on which one of the two
354+
builds Cargo picked to run first), whereas cargo build -j1
355+
--keep-going would definitely run both builds, even if the one run
356+
first fails.
351357

352358
--future-incompat-report
353359
Displays a future-incompat report for any future-incompatible

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

+7-1
Original file line numberDiff line numberDiff line change
@@ -332,7 +332,13 @@ OPTIONS
332332
--keep-going
333333
Build as many crates in the dependency graph as possible, rather
334334
than aborting the build on the first one that fails to build.
335-
Unstable, requires -Zunstable-options.
335+
336+
For example if the current package depends on dependencies fails and
337+
works, one of which fails to build, cargo check -j1 may or may not
338+
build the one that succeeds (depending on which one of the two
339+
builds Cargo picked to run first), whereas cargo check -j1
340+
--keep-going would definitely run both builds, even if the one run
341+
first fails.
336342

337343
--future-incompat-report
338344
Displays a future-incompat report for any future-incompatible

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

+7-1
Original file line numberDiff line numberDiff line change
@@ -303,7 +303,13 @@ OPTIONS
303303
--keep-going
304304
Build as many crates in the dependency graph as possible, rather
305305
than aborting the build on the first one that fails to build.
306-
Unstable, requires -Zunstable-options.
306+
307+
For example if the current package depends on dependencies fails and
308+
works, one of which fails to build, cargo doc -j1 may or may not
309+
build the one that succeeds (depending on which one of the two
310+
builds Cargo picked to run first), whereas cargo doc -j1
311+
--keep-going would definitely run both builds, even if the one run
312+
first fails.
307313

308314
ENVIRONMENT
309315
See the reference

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

+7-1
Original file line numberDiff line numberDiff line change
@@ -405,7 +405,13 @@ OPTIONS
405405
--keep-going
406406
Build as many crates in the dependency graph as possible, rather
407407
than aborting the build on the first one that fails to build.
408-
Unstable, requires -Zunstable-options.
408+
409+
For example if the current package depends on dependencies fails and
410+
works, one of which fails to build, cargo fix -j1 may or may not
411+
build the one that succeeds (depending on which one of the two
412+
builds Cargo picked to run first), whereas cargo fix -j1
413+
--keep-going would definitely run both builds, even if the one run
414+
first fails.
409415

410416
ENVIRONMENT
411417
See the reference

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

+7-1
Original file line numberDiff line numberDiff line change
@@ -280,7 +280,13 @@ OPTIONS
280280
--keep-going
281281
Build as many crates in the dependency graph as possible, rather
282282
than aborting the build on the first one that fails to build.
283-
Unstable, requires -Zunstable-options.
283+
284+
For example if the current package depends on dependencies fails and
285+
works, one of which fails to build, cargo install -j1 may or may not
286+
build the one that succeeds (depending on which one of the two
287+
builds Cargo picked to run first), whereas cargo install -j1
288+
--keep-going would definitely run both builds, even if the one run
289+
first fails.
284290

285291
Display Options
286292
-v, --verbose

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

+7-1
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,13 @@ OPTIONS
197197
--keep-going
198198
Build as many crates in the dependency graph as possible, rather
199199
than aborting the build on the first one that fails to build.
200-
Unstable, requires -Zunstable-options.
200+
201+
For example if the current package depends on dependencies fails and
202+
works, one of which fails to build, cargo package -j1 may or may not
203+
build the one that succeeds (depending on which one of the two
204+
builds Cargo picked to run first), whereas cargo package -j1
205+
--keep-going would definitely run both builds, even if the one run
206+
first fails.
201207

202208
Display Options
203209
-v, --verbose

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

+7-1
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,13 @@ OPTIONS
163163
--keep-going
164164
Build as many crates in the dependency graph as possible, rather
165165
than aborting the build on the first one that fails to build.
166-
Unstable, requires -Zunstable-options.
166+
167+
For example if the current package depends on dependencies fails and
168+
works, one of which fails to build, cargo publish -j1 may or may not
169+
build the one that succeeds (depending on which one of the two
170+
builds Cargo picked to run first), whereas cargo publish -j1
171+
--keep-going would definitely run both builds, even if the one run
172+
first fails.
167173

168174
Display Options
169175
-v, --verbose

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

+7-1
Original file line numberDiff line numberDiff line change
@@ -251,7 +251,13 @@ OPTIONS
251251
--keep-going
252252
Build as many crates in the dependency graph as possible, rather
253253
than aborting the build on the first one that fails to build.
254-
Unstable, requires -Zunstable-options.
254+
255+
For example if the current package depends on dependencies fails and
256+
works, one of which fails to build, cargo run -j1 may or may not
257+
build the one that succeeds (depending on which one of the two
258+
builds Cargo picked to run first), whereas cargo run -j1
259+
--keep-going would definitely run both builds, even if the one run
260+
first fails.
255261

256262
ENVIRONMENT
257263
See the reference

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

+7-1
Original file line numberDiff line numberDiff line change
@@ -349,7 +349,13 @@ OPTIONS
349349
--keep-going
350350
Build as many crates in the dependency graph as possible, rather
351351
than aborting the build on the first one that fails to build.
352-
Unstable, requires -Zunstable-options.
352+
353+
For example if the current package depends on dependencies fails and
354+
works, one of which fails to build, cargo rustc -j1 may or may not
355+
build the one that succeeds (depending on which one of the two
356+
builds Cargo picked to run first), whereas cargo rustc -j1
357+
--keep-going would definitely run both builds, even if the one run
358+
first fails.
353359

354360
--future-incompat-report
355361
Displays a future-incompat report for any future-incompatible

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

+7-1
Original file line numberDiff line numberDiff line change
@@ -319,7 +319,13 @@ OPTIONS
319319
--keep-going
320320
Build as many crates in the dependency graph as possible, rather
321321
than aborting the build on the first one that fails to build.
322-
Unstable, requires -Zunstable-options.
322+
323+
For example if the current package depends on dependencies fails and
324+
works, one of which fails to build, cargo rustdoc -j1 may or may not
325+
build the one that succeeds (depending on which one of the two
326+
builds Cargo picked to run first), whereas cargo rustdoc -j1
327+
--keep-going would definitely run both builds, even if the one run
328+
first fails.
323329

324330
ENVIRONMENT
325331
See the reference

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

+8
Original file line numberDiff line numberDiff line change
@@ -448,6 +448,14 @@ OPTIONS
448448

449449
See cargo-report(1)
450450

451+
While cargo test involves compilation, it does not provide a
452+
--keep-going flag. Use --no-fail-fast to run as many tests as possible
453+
without stopping at the first failure. To “compile” as many tests as
454+
possible, use --tests to build test binaries separately. For example:
455+
456+
cargo build --tests --keep-going
457+
cargo test --tests --no-fail-fast
458+
451459
ENVIRONMENT
452460
See the reference
453461
<https://doc.rust-lang.org/cargo/reference/environment-variables.html>

‎src/doc/man/includes/options-keep-going.md

+7-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
{{#option "`--keep-going`"}}
22
Build as many crates in the dependency graph as possible, rather than aborting
3-
the build on the first one that fails to build. Unstable, requires
4-
`-Zunstable-options`.
3+
the build on the first one that fails to build.
4+
5+
For example if the current package depends on dependencies `fails` and `works`,
6+
one of which fails to build, `cargo {{command}} -j1` may or may not build the
7+
one that succeeds (depending on which one of the two builds Cargo picked to run
8+
first), whereas `cargo {{command}} -j1 --keep-going` would definitely run both
9+
builds, even if the one run first fails.
510
{{/option}}

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

+7-5
Original file line numberDiff line numberDiff line change
@@ -478,13 +478,15 @@ a string <code>default</code> is provided, it sets the value back to defaults.
478478
Should not be 0.</dd>
479479

480480

481-
<dt class="option-term" id="option-cargo-bench---keep-going"><a class="option-anchor" href="#option-cargo-bench---keep-going"></a><code>--keep-going</code></dt>
482-
<dd class="option-desc">Build as many crates in the dependency graph as possible, rather than aborting
483-
the build on the first one that fails to build. Unstable, requires
484-
<code>-Zunstable-options</code>.</dd>
481+
</dl>
485482

483+
While `cargo bench` involves compilation, it does not provide a `--keep-going`
484+
flag. Use `--no-fail-fast` to run as many benchmarks as possible without
485+
stopping at the first failure. To "compile" as many benchmarks as possible, use
486+
`--benches` to build benchmark binaries separately. For example:
486487

487-
</dl>
488+
cargo build --benches --release --keep-going
489+
cargo bench --no-fail-fast
488490

489491
## ENVIRONMENT
490492

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

+6-2
Original file line numberDiff line numberDiff line change
@@ -407,8 +407,12 @@ Should not be 0.</dd>
407407

408408
<dt class="option-term" id="option-cargo-build---keep-going"><a class="option-anchor" href="#option-cargo-build---keep-going"></a><code>--keep-going</code></dt>
409409
<dd class="option-desc">Build as many crates in the dependency graph as possible, rather than aborting
410-
the build on the first one that fails to build. Unstable, requires
411-
<code>-Zunstable-options</code>.</dd>
410+
the build on the first one that fails to build.</p>
411+
<p>For example if the current package depends on dependencies <code>fails</code> and <code>works</code>,
412+
one of which fails to build, <code>cargo build -j1</code> may or may not build the
413+
one that succeeds (depending on which one of the two builds Cargo picked to run
414+
first), whereas <code>cargo build -j1 --keep-going</code> would definitely run both
415+
builds, even if the one run first fails.</dd>
412416

413417

414418
<dt class="option-term" id="option-cargo-build---future-incompat-report"><a class="option-anchor" href="#option-cargo-build---future-incompat-report"></a><code>--future-incompat-report</code></dt>

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

+6-2
Original file line numberDiff line numberDiff line change
@@ -388,8 +388,12 @@ Should not be 0.</dd>
388388

389389
<dt class="option-term" id="option-cargo-check---keep-going"><a class="option-anchor" href="#option-cargo-check---keep-going"></a><code>--keep-going</code></dt>
390390
<dd class="option-desc">Build as many crates in the dependency graph as possible, rather than aborting
391-
the build on the first one that fails to build. Unstable, requires
392-
<code>-Zunstable-options</code>.</dd>
391+
the build on the first one that fails to build.</p>
392+
<p>For example if the current package depends on dependencies <code>fails</code> and <code>works</code>,
393+
one of which fails to build, <code>cargo check -j1</code> may or may not build the
394+
one that succeeds (depending on which one of the two builds Cargo picked to run
395+
first), whereas <code>cargo check -j1 --keep-going</code> would definitely run both
396+
builds, even if the one run first fails.</dd>
393397

394398

395399
<dt class="option-term" id="option-cargo-check---future-incompat-report"><a class="option-anchor" href="#option-cargo-check---future-incompat-report"></a><code>--future-incompat-report</code></dt>

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

+6-2
Original file line numberDiff line numberDiff line change
@@ -362,8 +362,12 @@ Should not be 0.</dd>
362362

363363
<dt class="option-term" id="option-cargo-doc---keep-going"><a class="option-anchor" href="#option-cargo-doc---keep-going"></a><code>--keep-going</code></dt>
364364
<dd class="option-desc">Build as many crates in the dependency graph as possible, rather than aborting
365-
the build on the first one that fails to build. Unstable, requires
366-
<code>-Zunstable-options</code>.</dd>
365+
the build on the first one that fails to build.</p>
366+
<p>For example if the current package depends on dependencies <code>fails</code> and <code>works</code>,
367+
one of which fails to build, <code>cargo doc -j1</code> may or may not build the
368+
one that succeeds (depending on which one of the two builds Cargo picked to run
369+
first), whereas <code>cargo doc -j1 --keep-going</code> would definitely run both
370+
builds, even if the one run first fails.</dd>
367371

368372

369373
</dl>

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

+6-2
Original file line numberDiff line numberDiff line change
@@ -468,8 +468,12 @@ Should not be 0.</dd>
468468

469469
<dt class="option-term" id="option-cargo-fix---keep-going"><a class="option-anchor" href="#option-cargo-fix---keep-going"></a><code>--keep-going</code></dt>
470470
<dd class="option-desc">Build as many crates in the dependency graph as possible, rather than aborting
471-
the build on the first one that fails to build. Unstable, requires
472-
<code>-Zunstable-options</code>.</dd>
471+
the build on the first one that fails to build.</p>
472+
<p>For example if the current package depends on dependencies <code>fails</code> and <code>works</code>,
473+
one of which fails to build, <code>cargo fix -j1</code> may or may not build the
474+
one that succeeds (depending on which one of the two builds Cargo picked to run
475+
first), whereas <code>cargo fix -j1 --keep-going</code> would definitely run both
476+
builds, even if the one run first fails.</dd>
473477

474478

475479
</dl>

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

+6-2
Original file line numberDiff line numberDiff line change
@@ -317,8 +317,12 @@ Should not be 0.</dd>
317317

318318
<dt class="option-term" id="option-cargo-install---keep-going"><a class="option-anchor" href="#option-cargo-install---keep-going"></a><code>--keep-going</code></dt>
319319
<dd class="option-desc">Build as many crates in the dependency graph as possible, rather than aborting
320-
the build on the first one that fails to build. Unstable, requires
321-
<code>-Zunstable-options</code>.</dd>
320+
the build on the first one that fails to build.</p>
321+
<p>For example if the current package depends on dependencies <code>fails</code> and <code>works</code>,
322+
one of which fails to build, <code>cargo install -j1</code> may or may not build the
323+
one that succeeds (depending on which one of the two builds Cargo picked to run
324+
first), whereas <code>cargo install -j1 --keep-going</code> would definitely run both
325+
builds, even if the one run first fails.</dd>
322326

323327

324328
</dl>

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

+6-2
Original file line numberDiff line numberDiff line change
@@ -231,8 +231,12 @@ Should not be 0.</dd>
231231

232232
<dt class="option-term" id="option-cargo-package---keep-going"><a class="option-anchor" href="#option-cargo-package---keep-going"></a><code>--keep-going</code></dt>
233233
<dd class="option-desc">Build as many crates in the dependency graph as possible, rather than aborting
234-
the build on the first one that fails to build. Unstable, requires
235-
<code>-Zunstable-options</code>.</dd>
234+
the build on the first one that fails to build.</p>
235+
<p>For example if the current package depends on dependencies <code>fails</code> and <code>works</code>,
236+
one of which fails to build, <code>cargo package -j1</code> may or may not build the
237+
one that succeeds (depending on which one of the two builds Cargo picked to run
238+
first), whereas <code>cargo package -j1 --keep-going</code> would definitely run both
239+
builds, even if the one run first fails.</dd>
236240

237241

238242
</dl>

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

+6-2
Original file line numberDiff line numberDiff line change
@@ -198,8 +198,12 @@ Should not be 0.</dd>
198198

199199
<dt class="option-term" id="option-cargo-publish---keep-going"><a class="option-anchor" href="#option-cargo-publish---keep-going"></a><code>--keep-going</code></dt>
200200
<dd class="option-desc">Build as many crates in the dependency graph as possible, rather than aborting
201-
the build on the first one that fails to build. Unstable, requires
202-
<code>-Zunstable-options</code>.</dd>
201+
the build on the first one that fails to build.</p>
202+
<p>For example if the current package depends on dependencies <code>fails</code> and <code>works</code>,
203+
one of which fails to build, <code>cargo publish -j1</code> may or may not build the
204+
one that succeeds (depending on which one of the two builds Cargo picked to run
205+
first), whereas <code>cargo publish -j1 --keep-going</code> would definitely run both
206+
builds, even if the one run first fails.</dd>
203207

204208

205209
</dl>

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

+6-2
Original file line numberDiff line numberDiff line change
@@ -305,8 +305,12 @@ Should not be 0.</dd>
305305

306306
<dt class="option-term" id="option-cargo-run---keep-going"><a class="option-anchor" href="#option-cargo-run---keep-going"></a><code>--keep-going</code></dt>
307307
<dd class="option-desc">Build as many crates in the dependency graph as possible, rather than aborting
308-
the build on the first one that fails to build. Unstable, requires
309-
<code>-Zunstable-options</code>.</dd>
308+
the build on the first one that fails to build.</p>
309+
<p>For example if the current package depends on dependencies <code>fails</code> and <code>works</code>,
310+
one of which fails to build, <code>cargo run -j1</code> may or may not build the
311+
one that succeeds (depending on which one of the two builds Cargo picked to run
312+
first), whereas <code>cargo run -j1 --keep-going</code> would definitely run both
313+
builds, even if the one run first fails.</dd>
310314

311315

312316
</dl>

0 commit comments

Comments
 (0)