Skip to content
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

Jump to bottom

docs(ref): Index differences between virtual / real manifests #13794

Merged
merged 6 commits into from
Apr 25, 2024
Merged

docs(ref): Index differences between virtual / real manifests #13794

merged 6 commits into from
Apr 25, 2024

Commits on Apr 25, 2024

  1. docs(ref): Don't call out default-members is optional 

    Nothing else in the files does despite it all being optional and this
will be clearer in a follow up when I specify the defaults.
    @epage
    epage committed Apr 25, 2024
    Configuration menu
    Copy the full SHA
    6a213f7 View commit details
    Browse the repository at this point in the history

  2. docs(ref): Simplify default-members wording 

    This will make it easier to make future changes
    @epage
    epage committed Apr 25, 2024
    Configuration menu
    Copy the full SHA
    0b15bef View commit details
    Browse the repository at this point in the history

  3. docs(ref): Clarify default-members and members relationship 

    The old statement that its a subset of `members` is incorrect because
some members can be inferred and not show up in `members`.

I tried to reword this to better convey the goal of what was being said
    @epage
    epage committed Apr 25, 2024
    Configuration menu
    Copy the full SHA
    58415ff View commit details
    Browse the repository at this point in the history

  4. docs(ref): Move default-members defalting to default-members 

    This also tweaks the wording to be clear that `default-members` always
apply in the workspace root, not just for virtual workspaces.
    @epage
    epage committed Apr 25, 2024
    Configuration menu
    Copy the full SHA
    2289026 View commit details
    Browse the repository at this point in the history

  5. docs(ref): Add a caution about default-members with root package

    @epage
    epage committed Apr 25, 2024
    Configuration menu
    Copy the full SHA
    50adf47 View commit details
    Browse the repository at this point in the history

  6. 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 rust-lang#13580
    @epage
    epage committed Apr 25, 2024
    Configuration menu
    Copy the full SHA
    5f5e0fc View commit details
    Browse the repository at this point in the history