From 7158c279f70f36b41f9db801e0778fcd97a053b9 Mon Sep 17 00:00:00 2001 From: Andrew Certain Date: Wed, 3 Sep 2025 12:56:35 -0700 Subject: [PATCH] Update note on default-members and root package Clarify usage of default-members with root package in workspaces. --- src/doc/src/reference/workspaces.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/src/doc/src/reference/workspaces.md b/src/doc/src/reference/workspaces.md index a923e3ebd18..88d53018df6 100644 --- a/src/doc/src/reference/workspaces.md +++ b/src/doc/src/reference/workspaces.md @@ -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. -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