Skip to content

Commit fe0e5a4

Browse files
borsbors
committed
Auto merge of #7241 - k-nasa:all_to_workspace, r=ehuss
Rename `--all` to `--workspace` ## Background close: #6977 ## Description - Warn when using the 'all' option - Changed help text
2 parents 49fbf52 + ecf824f commit fe0e5a4

34 files changed

+165
-105
lines changed

‎src/bin/cargo/commands/bench.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,9 +59,9 @@ which indicates which package should be benchmarked. If it is not given, then
5959
the current package is benchmarked. For more information on SPEC and its format,
6060
see the `cargo help pkgid` command.
6161
62-
All packages in the workspace are benchmarked if the `--all` flag is supplied. The
63-
`--all` flag is automatically assumed for a virtual manifest.
64-
Note that `--exclude` has to be specified in conjunction with the `--all` flag.
62+
All packages in the workspace are benchmarked if the `--workspace` flag is supplied. The
63+
`--workspace` flag is automatically assumed for a virtual manifest.
64+
Note that `--exclude` has to be specified in conjunction with the `--workspace` flag.
6565
6666
The `--jobs` argument affects the building of the benchmark executable but does
6767
not affect how many jobs are used when running the benchmarks.

‎src/bin/cargo/commands/build.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,9 @@ pub fn cli() -> App {
4242
.arg_build_plan()
4343
.after_help(
4444
"\
45-
All packages in the workspace are built if the `--all` flag is supplied. The
46-
`--all` flag is automatically assumed for a virtual manifest.
47-
Note that `--exclude` has to be specified in conjunction with the `--all` flag.
45+
All packages in the workspace are built if the `--workspace` flag is supplied. The
46+
`--workspace` flag is automatically assumed for a virtual manifest.
47+
Note that `--exclude` has to be specified in conjunction with the `--workspace` flag.
4848
4949
Compilation can be configured via the use of profiles which are configured in
5050
the manifest. The default profile for this command is `dev`, but passing

‎src/bin/cargo/commands/check.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,9 @@ which indicates which package should be built. If it is not given, then the
4040
current package is built. For more information on SPEC and its format, see the
4141
`cargo help pkgid` command.
4242
43-
All packages in the workspace are checked if the `--all` flag is supplied. The
44-
`--all` flag is automatically assumed for a virtual manifest.
45-
Note that `--exclude` has to be specified in conjunction with the `--all` flag.
43+
All packages in the workspace are checked if the `--workspace` flag is supplied. The
44+
`--workspace` flag is automatically assumed for a virtual manifest.
45+
Note that `--exclude` has to be specified in conjunction with the `--workspace` flag.
4646
4747
Compilation can be configured via the use of profiles which are configured in
4848
the manifest. The default profile for this command is `dev`, but passing

‎src/bin/cargo/commands/clippy.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,9 @@ which indicates which package should be built. If it is not given, then the
3838
current package is built. For more information on SPEC and its format, see the
3939
`cargo help pkgid` command.
4040
41-
All packages in the workspace are checked if the `--all` flag is supplied. The
42-
`--all` flag is automatically assumed for a virtual manifest.
43-
Note that `--exclude` has to be specified in conjunction with the `--all` flag.
41+
All packages in the workspace are checked if the `--workspace` flag is supplied. The
42+
`--workspace` flag is automatically assumed for a virtual manifest.
43+
Note that `--exclude` has to be specified in conjunction with the `--workspace` flag.
4444
4545
To allow or deny a lint from the command line you can use `cargo clippy --`
4646
with:

‎src/bin/cargo/commands/doc.rs

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,10 @@ pub fn cli() -> App {
3434
By default the documentation for the local package and all dependencies is
3535
built. The output is all placed in `target/doc` in rustdoc's usual format.
3636
37-
All packages in the workspace are documented if the `--all` flag is supplied. The
38-
`--all` flag is automatically assumed for a virtual manifest.
39-
Note that `--exclude` has to be specified in conjunction with the `--all` flag.
37+
All packages in the workspace are documented if the `--workspace` flag is
38+
supplied. The `--workspace` flag is automatically assumed for a virtual
39+
manifest. Note that `--exclude` has to be specified in conjunction with the
40+
`--workspace` flag.
4041
4142
If the `--package` argument is given, then SPEC is a package ID specification
4243
which indicates which package should be documented. If it is not given, then the

‎src/bin/cargo/commands/test.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -69,9 +69,9 @@ which indicates which package should be tested. If it is not given, then the
6969
current package is tested. For more information on SPEC and its format, see the
7070
`cargo help pkgid` command.
7171
72-
All packages in the workspace are tested if the `--all` flag is supplied. The
73-
`--all` flag is automatically assumed for a virtual manifest.
74-
Note that `--exclude` has to be specified in conjunction with the `--all` flag.
72+
All packages in the workspace are tested if the `--workspace` flag is supplied. The
73+
`--workspace` flag is automatically assumed for a virtual manifest.
74+
Note that `--exclude` has to be specified in conjunction with the `--workspace` flag.
7575
7676
The `--jobs` argument affects the building of the test executable but does
7777
not affect how many jobs are used when running the tests. The default value

‎src/cargo/core/workspace.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,13 +56,13 @@ pub struct Workspace<'cfg> {
5656

5757
// The subset of `members` that are used by the
5858
// `build`, `check`, `test`, and `bench` subcommands
59-
// when no package is selected with `--package` / `-p` and `--all`
59+
// when no package is selected with `--package` / `-p` and `--workspace`
6060
// is not used.
6161
//
6262
// This is set by the `default-members` config
6363
// in the `[workspace]` section.
6464
// When unset, this is the same as `members` for virtual workspaces
65-
// (`--all` is implied)
65+
// (`--workspace` is implied)
6666
// or only the root package for non-virtual workspaces.
6767
default_members: Vec<PathBuf>,
6868

‎src/cargo/ops/cargo_compile.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ impl Packages {
106106
Ok(match (all, exclude.len(), package.len()) {
107107
(false, 0, 0) => Packages::Default,
108108
(false, 0, _) => Packages::Packages(package),
109-
(false, _, _) => failure::bail!("--exclude can only be used together with --all"),
109+
(false, _, _) => failure::bail!("--exclude can only be used together with --workspace"),
110110
(true, 0, _) => Packages::All,
111111
(true, _, _) => Packages::OptOut(exclude),
112112
})

‎src/cargo/util/command_prelude.rs

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,8 @@ pub trait AppExt: Sized {
3131
exclude: &'static str,
3232
) -> Self {
3333
self.arg_package_spec_simple(package)
34-
._arg(opt("all", all))
34+
._arg(opt("all", "Alias for --workspace (deprecated)"))
35+
._arg(opt("workspace", all))
3536
._arg(multi_opt("exclude", "SPEC", exclude))
3637
}
3738

@@ -290,7 +291,8 @@ pub trait ArgMatchesExt {
290291
workspace: Option<&Workspace<'a>>,
291292
) -> CargoResult<CompileOptions<'a>> {
292293
let spec = Packages::from_flags(
293-
self._is_present("all"),
294+
// TODO Integrate into 'workspace'
295+
self._is_present("workspace") || self._is_present("all"),
294296
self._values_of("exclude"),
295297
self._values_of("package"),
296298
)?;

‎src/doc/man/generated/cargo-bench.html

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ <h3 id="cargo_bench_package_selection">Package Selection</h3>
7878
<p>The default members of a workspace can be set explicitly with the
7979
<code>workspace.default-members</code> key in the root manifest. If this is not set, a
8080
virtual workspace will include all workspace members (equivalent to passing
81-
<code>--all</code>), and a non-virtual workspace will include only the root crate itself.</p>
81+
<code>--workspace</code>), and a non-virtual workspace will include only the root crate itself.</p>
8282
</div>
8383
<div class="dlist">
8484
<dl>
@@ -88,14 +88,18 @@ <h3 id="cargo_bench_package_selection">Package Selection</h3>
8888
<p>Benchmark only the specified packages. See <a href="cargo-pkgid.html">cargo-pkgid(1)</a> for the
8989
SPEC format. This flag may be specified multiple times.</p>
9090
</dd>
91-
<dt class="hdlist1"><strong>--all</strong></dt>
91+
<dt class="hdlist1"><strong>--workspace</strong></dt>
9292
<dd>
9393
<p>Benchmark all members in the workspace.</p>
9494
</dd>
95+
<dt class="hdlist1"><strong>--all</strong></dt>
96+
<dd>
97+
<p>Deprecated alias for <code>--workspace</code>.</p>
98+
</dd>
9599
<dt class="hdlist1"><strong>--exclude</strong> <em>SPEC</em>&#8230;&#8203;</dt>
96100
<dd>
97101
<p>Exclude the specified packages. Must be used in conjunction with the
98-
<code>--all</code> flag. This flag may be specified multiple times.</p>
102+
<code>--workspace</code> flag. This flag may be specified multiple times.</p>
99103
</dd>
100104
</dl>
101105
</div>

0 commit comments

Comments
 (0)