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.

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

doc: improve west's repo-tool.rst #31119

Merged

Commits on Jan 6, 2021

  1. doc: improve west's repo-tool.rst

    Various improvements to the west repo-tool.rst page and pages that
    link to it:
    
    Rename the page title to "Basics", since it documents, well the
    basics, including built-in commands like "help" an "config" that are
    not directly related to multiple repositories.
    
    The "multi-repo" term was invented before we started using
    "workspace". Drop it from the text and rework things using words like
    "workspace", "basics", or "built-ins" instead, which read better.
    
    We've been using west for a long enough time that justifying its
    existence prominently at the start of this page is no longer
    necessary; move that to the "dustbin of history" page (why.rst).
    
    Try harder to clarify exactly what a "project" is, along with other
    workspace related clarifications.
    
    Improve the documentation for the west init and west update commands,
    and create :ref: targets for linking directly to them for convenience
    elsewhere in the docs.
    
    Slim down the usages for other built-in commands, so we don't have to
    keep those up to date as carefully each release. This is about to be
    important for west 0.9, which is going to change the detailed
    semantics for the "[PROJECT ...]" part of each command synopsis in a
    way that will be inconvenient to duplicate for each of these.
    
    Move the "Topologies supported" content lower down. Try to help the
    reading flow by letting people get familiar with a workspace and what
    you can do with it using the Zephyr GSG workspace that they probably
    already have before overwhelming them with other possibilities and
    choices.
    
    Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
    mbolivar-nordic committed Jan 6, 2021
    Configuration menu
    Copy the full SHA
    c769e5c View commit details
    Browse the repository at this point in the history