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): Clarify workspace settings #11082

Merged
merged 9 commits into from
Sep 16, 2022
Merged

docs(ref): Clarify workspace settings #11082

merged 9 commits into from
Sep 16, 2022

Commits on Sep 13, 2022

  1. docs(ref): Re-org workspace docs to be like package docs 

    In looking over rust-lang#10625, I remembered we've been having growing pains
with the workspace documentation.  It was originally written when there
were a lot fewer workspace features.  As more workspace features have
been added, they've been tacked on to the documentation.

This re-thinks the documentation by focusing on the schema, much like
`manifest.md` does.
    @epage
    epage committed Sep 13, 2022
    Configuration menu
    Copy the full SHA
    b5bcd47 View commit details
    Browse the repository at this point in the history

  2. docs(ref): Have workspace docs link out to resolver field docs 

    This is a part of the schema we were missing.  A first step before
encouraging people to use it is to document it!
    @epage
    epage committed Sep 13, 2022
    Configuration menu
    Copy the full SHA
    5189a81 View commit details
    Browse the repository at this point in the history

  3. docs(ref): Have workspace docs link out to profile section docs 

    In a workspace, only the workspace's profile is respected.  This is
already documented in the profile documentation but we should raise
visibility of it within the workspace documentation.
    @epage
    epage committed Sep 13, 2022
    Configuration menu
    Copy the full SHA
    a841274 View commit details
    Browse the repository at this point in the history

  4. docs(ref): Have workspace docs link out to patch/replace docs 

    The workspace behavior doesn't seem to be documented at all, so a blurb
was brought in that is like the profile blurb.  The workspace docs then
link out to it so users can be aware of this special workspace behavior.
    @epage
    epage committed Sep 13, 2022
    Configuration menu
    Copy the full SHA
    fb510f5 View commit details
    Browse the repository at this point in the history

  5. docs(ref): Move metadata to last

    @epage
    epage committed Sep 13, 2022
    Configuration menu
    Copy the full SHA
    0e09e5c View commit details
    Browse the repository at this point in the history

  6. docs(ref): Remove redundant workspace description

    @epage
    epage committed Sep 13, 2022
    Configuration menu
    Copy the full SHA
    c08ecbb View commit details
    Browse the repository at this point in the history

  7. docs(ref): Add --workspace as a key point 

    This is a frequent reason I use them
    @epage
    epage committed Sep 13, 2022
    Configuration menu
    Copy the full SHA
    f1da8c4 View commit details
    Browse the repository at this point in the history

  8. docs(ref): Include workspace inheritane

    @epage
    epage committed Sep 13, 2022
    Configuration menu
    Copy the full SHA
    cad833d View commit details
    Browse the repository at this point in the history

  9. docs(ref): Provide path for people to finding why shared Cargo.lock m… 

    …atters
    @epage
    epage committed Sep 13, 2022
    Configuration menu
    Copy the full SHA
    f39f8dc View commit details
    Browse the repository at this point in the history