docs(workspace): add recommended structure subsection to members field#17166
docs(workspace): add recommended structure subsection to members field#17166raushan728 wants to merge 1 commit into
Conversation
rustbot
added
A-documenting-cargo-itself
|
r? @epage rustbot has assigned @epage. Use Why was this reviewer chosen?The reviewer was selected based on:
|
raushan728
changed the title
This comment has been minimized.
This comment has been minimized.
|
This PR was rebased onto a different master commit. Here's a range-diff highlighting what actually changed. Rebasing is a normal part of keeping PRs up to date, so no action is needed—this note is just to help reviewers. |
| typical filename glob patterns like `*` and `?`. | ||
|
|
||
| ### Recommended structure | ||
|
|
||
| It is recommended to keep all member packages in a flat directory (commonly `crates/`) and use a glob pattern for the `members` field, e.g. `members = ["crates/*"]`. This makes it easy to add new members with `cargo new` / `cargo init` without editing the root manifest. | ||
|
|
||
| The `exclude` key can be used to prevent paths from being included in a |
There was a problem hiding this comment.
While this is adding a new section, it is taking existing content and putting it in that section.
Likely we should have a recommendation block like we do at https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#version-metadata that is linked to from #11234 (comment)
| typical filename glob patterns like `*` and `?`. | ||
|
|
||
| ### Recommended structure | ||
|
|
||
| It is recommended to keep all member packages in a flat directory (commonly `crates/`) and use a glob pattern for the `members` field, e.g. `members = ["crates/*"]`. This makes it easy to add new members with `cargo new` / `cargo init` without editing the root manifest. | ||
|
|
||
| The `exclude` key can be used to prevent paths from being included in a |
There was a problem hiding this comment.
The framing on this feels a bit strong and "it is recommended" is passive voice.
I'm hoping mirroring what we do at https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#version-metadata would help
4 participants
Closes #11234