Skip to content

Commit 6eea77f

Browse files
committed
docs(ref): Index differences between virtual / real manifests
For a user to read the reference and to understand when each type of workspace might be right for them, they have to know to also read the section on Package Selection. This reframes the section on needing to set `resolver = "2"` to being about differences when there isn't a root package and extends it to summarize a part of Package Selection, linking out to it. The hope is that this will make it all of the differences more discoverable without retreading too much of the same ground within Reference-style documentation. Part of #13580
1 parent 50adf47 commit 6eea77f

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

src/doc/src/reference/workspaces.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -80,10 +80,14 @@ edition = "2021" # the edition, will have no effect on a resolver used in th
8080
authors = ["Alice <[email protected]>", "Bob <[email protected]>"]
8181
```
8282

83-
Note that in a virtual manifest the [`resolver = "2"`](resolver.md#resolver-versions)
84-
should be specified manually. It is usually deduced from the [`package.edition`][package-edition]
85-
field which is absent in virtual manifests and the edition field of a member
86-
won't affect the resolver used by the workspace.
83+
By having a workspace without a root package,
84+
85+
- [`resolver`](resolver.md#resolver-versions) must be
86+
set explicitly in virtual workspaces as they have no
87+
[`package.edition`][package-edition] to infer it from.
88+
[resolver version](resolver.md#resolver-versions).
89+
- Commands run in the workspace root will run against all workspace
90+
members by default, see [`default-members`](#default-members).
8791

8892
## The `members` and `exclude` fields
8993

0 commit comments

Comments
 (0)