Skip to content

Update note on default-members and root package #15916

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update note on default-members and root package #15916

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions src/doc/src/reference/workspaces.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,11 +137,12 @@ members = ["path/to/member1", "path/to/member2", "path/to/member3/*"]
default-members = ["path/to/member2", "path/to/member3/foo"]
```

> Note: when a [root package](#root-package) is present,
> you can only operate on it using `--package` and `--workspace` flags.
> Note: If `default-members` is specified and a [root package](#root-package) is present,
> you can only operate on the root package using `--package` and `--workspace` flags.
> There is no way to specify the root package explicitly in the `default-members` field.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually you can do that through default-members = ["."].

Maybe we should remove this instead?


When unspecified, the [root package](#root-package) will be used.
In the case of a [virtual workspace](#virtual-workspace), all members will be used
When unspecified, the [root package](#root-package) will be used, except in the case of
a [virtual workspace](#virtual-workspace), where all members will be used
(as if `--workspace` were specified on the command-line).

## The `package` table
Expand Down
Loading