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

+3-3
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

+3-3
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

+3-3
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

+3-3
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

+4-3
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

+3-3
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

+2-2
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

+1-1
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

+4-2
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

+7-3
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>

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

+7-3
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ <h3 id="cargo_build_package_selection">Package Selection</h3>
3434
<p>The default members of a workspace can be set explicitly with the
3535
<code>workspace.default-members</code> key in the root manifest. If this is not set, a
3636
virtual workspace will include all workspace members (equivalent to passing
37-
<code>--all</code>), and a non-virtual workspace will include only the root crate itself.</p>
37+
<code>--workspace</code>), and a non-virtual workspace will include only the root crate itself.</p>
3838
</div>
3939
<div class="dlist">
4040
<dl>
@@ -44,14 +44,18 @@ <h3 id="cargo_build_package_selection">Package Selection</h3>
4444
<p>Build only the specified packages. See <a href="cargo-pkgid.html">cargo-pkgid(1)</a> for the
4545
SPEC format. This flag may be specified multiple times.</p>
4646
</dd>
47-
<dt class="hdlist1"><strong>--all</strong></dt>
47+
<dt class="hdlist1"><strong>--workspace</strong></dt>
4848
<dd>
4949
<p>Build all members in the workspace.</p>
5050
</dd>
51+
<dt class="hdlist1"><strong>--all</strong></dt>
52+
<dd>
53+
<p>Deprecated alias for <code>--workspace</code>.</p>
54+
</dd>
5155
<dt class="hdlist1"><strong>--exclude</strong> <em>SPEC</em>&#8230;&#8203;</dt>
5256
<dd>
5357
<p>Exclude the specified packages. Must be used in conjunction with the
54-
<code>--all</code> flag. This flag may be specified multiple times.</p>
58+
<code>--workspace</code> flag. This flag may be specified multiple times.</p>
5559
</dd>
5660
</dl>
5761
</div>

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

+7-3
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ <h3 id="cargo_check_package_selection">Package Selection</h3>
3838
<p>The default members of a workspace can be set explicitly with the
3939
<code>workspace.default-members</code> key in the root manifest. If this is not set, a
4040
virtual workspace will include all workspace members (equivalent to passing
41-
<code>--all</code>), and a non-virtual workspace will include only the root crate itself.</p>
41+
<code>--workspace</code>), and a non-virtual workspace will include only the root crate itself.</p>
4242
</div>
4343
<div class="dlist">
4444
<dl>
@@ -48,14 +48,18 @@ <h3 id="cargo_check_package_selection">Package Selection</h3>
4848
<p>Check only the specified packages. See <a href="cargo-pkgid.html">cargo-pkgid(1)</a> for the
4949
SPEC format. This flag may be specified multiple times.</p>
5050
</dd>
51-
<dt class="hdlist1"><strong>--all</strong></dt>
51+
<dt class="hdlist1"><strong>--workspace</strong></dt>
5252
<dd>
5353
<p>Check all members in the workspace.</p>
5454
</dd>
55+
<dt class="hdlist1"><strong>--all</strong></dt>
56+
<dd>
57+
<p>Deprecated alias for <code>--workspace</code>.</p>
58+
</dd>
5559
<dt class="hdlist1"><strong>--exclude</strong> <em>SPEC</em>&#8230;&#8203;</dt>
5660
<dd>
5761
<p>Exclude the specified packages. Must be used in conjunction with the
58-
<code>--all</code> flag. This flag may be specified multiple times.</p>
62+
<code>--workspace</code> flag. This flag may be specified multiple times.</p>
5963
</dd>
6064
</dl>
6165
</div>

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

+7-3
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ <h3 id="cargo_doc_package_selection">Package Selection</h3>
5454
<p>The default members of a workspace can be set explicitly with the
5555
<code>workspace.default-members</code> key in the root manifest. If this is not set, a
5656
virtual workspace will include all workspace members (equivalent to passing
57-
<code>--all</code>), and a non-virtual workspace will include only the root crate itself.</p>
57+
<code>--workspace</code>), and a non-virtual workspace will include only the root crate itself.</p>
5858
</div>
5959
<div class="dlist">
6060
<dl>
@@ -64,14 +64,18 @@ <h3 id="cargo_doc_package_selection">Package Selection</h3>
6464
<p>Document only the specified packages. See <a href="cargo-pkgid.html">cargo-pkgid(1)</a> for the
6565
SPEC format. This flag may be specified multiple times.</p>
6666
</dd>
67-
<dt class="hdlist1"><strong>--all</strong></dt>
67+
<dt class="hdlist1"><strong>--workspace</strong></dt>
6868
<dd>
6969
<p>Document all members in the workspace.</p>
7070
</dd>
71+
<dt class="hdlist1"><strong>--all</strong></dt>
72+
<dd>
73+
<p>Deprecated alias for <code>--workspace</code>.</p>
74+
</dd>
7175
<dt class="hdlist1"><strong>--exclude</strong> <em>SPEC</em>&#8230;&#8203;</dt>
7276
<dd>
7377
<p>Exclude the specified packages. Must be used in conjunction with the
74-
<code>--all</code> flag. This flag may be specified multiple times.</p>
78+
<code>--workspace</code> flag. This flag may be specified multiple times.</p>
7579
</dd>
7680
</dl>
7781
</div>

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

+7-3
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ <h3 id="cargo_fix_package_selection">Package Selection</h3>
109109
<p>The default members of a workspace can be set explicitly with the
110110
<code>workspace.default-members</code> key in the root manifest. If this is not set, a
111111
virtual workspace will include all workspace members (equivalent to passing
112-
<code>--all</code>), and a non-virtual workspace will include only the root crate itself.</p>
112+
<code>--workspace</code>), and a non-virtual workspace will include only the root crate itself.</p>
113113
</div>
114114
<div class="dlist">
115115
<dl>
@@ -119,14 +119,18 @@ <h3 id="cargo_fix_package_selection">Package Selection</h3>
119119
<p>Fix only the specified packages. See <a href="cargo-pkgid.html">cargo-pkgid(1)</a> for the
120120
SPEC format. This flag may be specified multiple times.</p>
121121
</dd>
122-
<dt class="hdlist1"><strong>--all</strong></dt>
122+
<dt class="hdlist1"><strong>--workspace</strong></dt>
123123
<dd>
124124
<p>Fix all members in the workspace.</p>
125125
</dd>
126+
<dt class="hdlist1"><strong>--all</strong></dt>
127+
<dd>
128+
<p>Deprecated alias for <code>--workspace</code>.</p>
129+
</dd>
126130
<dt class="hdlist1"><strong>--exclude</strong> <em>SPEC</em>&#8230;&#8203;</dt>
127131
<dd>
128132
<p>Exclude the specified packages. Must be used in conjunction with the
129-
<code>--all</code> flag. This flag may be specified multiple times.</p>
133+
<code>--workspace</code> flag. This flag may be specified multiple times.</p>
130134
</dd>
131135
</dl>
132136
</div>

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

+7-3
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ <h3 id="cargo_test_package_selection">Package Selection</h3>
8484
<p>The default members of a workspace can be set explicitly with the
8585
<code>workspace.default-members</code> key in the root manifest. If this is not set, a
8686
virtual workspace will include all workspace members (equivalent to passing
87-
<code>--all</code>), and a non-virtual workspace will include only the root crate itself.</p>
87+
<code>--workspace</code>), and a non-virtual workspace will include only the root crate itself.</p>
8888
</div>
8989
<div class="dlist">
9090
<dl>
@@ -94,14 +94,18 @@ <h3 id="cargo_test_package_selection">Package Selection</h3>
9494
<p>Test only the specified packages. See <a href="cargo-pkgid.html">cargo-pkgid(1)</a> for the
9595
SPEC format. This flag may be specified multiple times.</p>
9696
</dd>
97-
<dt class="hdlist1"><strong>--all</strong></dt>
97+
<dt class="hdlist1"><strong>--workspace</strong></dt>
9898
<dd>
9999
<p>Test all members in the workspace.</p>
100100
</dd>
101+
<dt class="hdlist1"><strong>--all</strong></dt>
102+
<dd>
103+
<p>Deprecated alias for <code>--workspace</code>.</p>
104+
</dd>
101105
<dt class="hdlist1"><strong>--exclude</strong> <em>SPEC</em>&#8230;&#8203;</dt>
102106
<dd>
103107
<p>Exclude the specified packages. Must be used in conjunction with the
104-
<code>--all</code> flag. This flag may be specified multiple times.</p>
108+
<code>--workspace</code> flag. This flag may be specified multiple times.</p>
105109
</dd>
106110
</dl>
107111
</div>

‎src/doc/man/options-packages.adoc

+6-3
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,19 @@ by the manifest will be selected.
77
The default members of a workspace can be set explicitly with the
88
`workspace.default-members` key in the root manifest. If this is not set, a
99
virtual workspace will include all workspace members (equivalent to passing
10-
`--all`), and a non-virtual workspace will include only the root crate itself.
10+
`--workspace`), and a non-virtual workspace will include only the root crate itself.
1111

1212
*-p* _SPEC_...::
1313
*--package* _SPEC_...::
1414
{actionverb} only the specified packages. See man:cargo-pkgid[1] for the
1515
SPEC format. This flag may be specified multiple times.
1616

17-
*--all*::
17+
*--workspace*::
1818
{actionverb} all members in the workspace.
1919

20+
*--all*::
21+
Deprecated alias for `--workspace`.
22+
2023
*--exclude* _SPEC_...::
2124
Exclude the specified packages. Must be used in conjunction with the
22-
`--all` flag. This flag may be specified multiple times.
25+
`--workspace` flag. This flag may be specified multiple times.

‎src/doc/src/reference/manifest.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -658,7 +658,7 @@ manifest*.
658658
#### Package selection
659659

660660
In a workspace, package-related cargo commands like [`cargo build`] apply to
661-
packages selected by `-p` / `--package` or `--all` command-line parameters.
661+
packages selected by `-p` / `--package` or `--workspace` command-line parameters.
662662
When neither is specified, the optional `default-members` configuration is used:
663663

664664
```toml
@@ -670,7 +670,7 @@ default-members = ["path/to/member2", "path/to/member3/foo"]
670670
When specified, `default-members` must expand to a subset of `members`.
671671

672672
When `default-members` is not specified, the default is the root manifest
673-
if it is a package, or every member manifest (as if `--all` were specified
673+
if it is a package, or every member manifest (as if `--workspace` were specified
674674
on the command-line) for virtual workspaces.
675675

676676
### The project layout

‎src/etc/cargo.bashcomp.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ _cargo()
3737
local opt_quiet='-q --quiet'
3838
local opt_color='--color'
3939
local opt_common="$opt_help $opt_verbose $opt_quiet $opt_color"
40-
local opt_pkg_spec='-p --package --all --exclude'
40+
local opt_pkg_spec='-p --package --all --exclude --workspace'
4141
local opt_pkg='-p --package'
4242
local opt_feat='--features --all-features --no-default-features'
4343
local opt_mani='--manifest-path'

‎src/etc/man/cargo-bench.1

+8-3
Original file line numberDiff line numberDiff line change
@@ -85,23 +85,28 @@ by the manifest will be selected.
8585
The default members of a workspace can be set explicitly with the
8686
\fBworkspace.default\-members\fP key in the root manifest. If this is not set, a
8787
virtual workspace will include all workspace members (equivalent to passing
88-
\fB\-\-all\fP), and a non\-virtual workspace will include only the root crate itself.
88+
\fB\-\-workspace\fP), and a non\-virtual workspace will include only the root crate itself.
8989
.sp
9090
\fB\-p\fP \fISPEC\fP..., \fB\-\-package\fP \fISPEC\fP...
9191
.RS 4
9292
Benchmark only the specified packages. See \fBcargo\-pkgid\fP(1) for the
9393
SPEC format. This flag may be specified multiple times.
9494
.RE
9595
.sp
96-
\fB\-\-all\fP
96+
\fB\-\-workspace\fP
9797
.RS 4
9898
Benchmark all members in the workspace.
9999
.RE
100100
.sp
101+
\fB\-\-all\fP
102+
.RS 4
103+
Deprecated alias for \fB\-\-workspace\fP.
104+
.RE
105+
.sp
101106
\fB\-\-exclude\fP \fISPEC\fP...
102107
.RS 4
103108
Exclude the specified packages. Must be used in conjunction with the
104-
\fB\-\-all\fP flag. This flag may be specified multiple times.
109+
\fB\-\-workspace\fP flag. This flag may be specified multiple times.
105110
.RE
106111
.SS "Target Selection"
107112
.sp

0 commit comments

Comments
 (0)