Skip to content

Commit

Permalink
docs(ref): Index differences between virtual / real manifests
Browse files Browse the repository at this point in the history
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
  • Loading branch information
epage committed Apr 23, 2024
1 parent b89b81a commit 7317187
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions src/doc/src/reference/workspaces.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,10 +80,14 @@ edition = "2021" # the edition, will have no effect on a resolver used in th
authors = ["Alice <[email protected]>", "Bob <[email protected]>"]
```

Note that in a virtual manifest the [`resolver = "2"`](resolver.md#resolver-versions)
should be specified manually. It is usually deduced from the [`package.edition`][package-edition]
field which is absent in virtual manifests and the edition field of a member
won't affect the resolver used by the workspace.
When there isn't a root package:

- [`resolver = "2"`](resolver.md#resolver-versions) must be
set explicitly in virtual workspaces as they have no
[`package.edition`][package-edition] to infer it from.
[resolver version](resolver.md#resolver-versions).
- Commands run in the workspace's directory will run against all workspace
members by default, see [Package selection](#package-selection).

## The `members` and `exclude` fields

Expand Down

0 comments on commit 7317187

Please sign in to comment.