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

West documentation is largely missing #14992

Closed
mbolivar opened this issue Mar 28, 2019 · 0 comments · Fixed by #14983
Closed

West documentation is largely missing #14992

mbolivar opened this issue Mar 28, 2019 · 0 comments · Fixed by #14983
Assignees
@mbolivar
Labels
bug The issue is a bug, or the PR is fixing a bug priority: high High impact/importance bug
Milestone
v1.14.0

Comments

@mbolivar
Copy link
Contributor

The documentation for west has several inaccurate statements when it comes to the multi-repo commands, and is missing entirely for several features:

  • configuration
  • extension commands in general
  • the sign extension command

Additionally, API documentation is missing.

Since west is part of the getting started guide now, we need to fix this so users can learn how to use it without having to make guesses based on online help and the source code.
@mbolivar mbolivar added bug The issue is a bug, or the PR is fixing a bug priority: high High impact/importance bug labels Mar 28, 2019
@mbolivar mbolivar added this to the v1.14.0 milestone Mar 28, 2019
@mbolivar mbolivar mentioned this issue Mar 28, 2019
Merged
mbolivar pushed a commit to mbolivar/zephyr that referenced this issue Mar 28, 2019
doc: west: add missing parts for zephyr v1.14
95a12a9 
- add glossary terms for important concepts we have to explain often,
  like "west installation"

- add autodoc directives for pulling in west API docs

- add missing documentation for built-in features like west's
  configuration, extension commands, etc.

- add missing documentation for "west sign" extension

- describe the manifest in a self-contained way rather than linking to
  the relevant pykwalify schema, also adding a missing reference to
  "west manifest" in the miscellaneous multi-repo commands list

- move various details regarding history and motivation to why.rst
  among other changes to repo-tool.rst, leaving it closer to a "tell
  me what I really need to know" style overview

- update planned features

Fixes: zephyrproject-rtos#14992
Signed-off-by: Marti Bolivar <[email protected]>
carlescufi pushed a commit that referenced this issue Mar 29, 2019
@carlescufi
doc: west: add missing parts for zephyr v1.14
d3bb3cf 
- add glossary terms for important concepts we have to explain often,
  like "west installation"

- add autodoc directives for pulling in west API docs

- add missing documentation for built-in features like west's
  configuration, extension commands, etc.

- add missing documentation for "west sign" extension

- describe the manifest in a self-contained way rather than linking to
  the relevant pykwalify schema, also adding a missing reference to
  "west manifest" in the miscellaneous multi-repo commands list

- move various details regarding history and motivation to why.rst
  among other changes to repo-tool.rst, leaving it closer to a "tell
  me what I really need to know" style overview

- update planned features

Fixes: #14992
Signed-off-by: Marti Bolivar <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mbolivar mbolivar

Labels
bug The issue is a bug, or the PR is fixing a bug priority: high High impact/importance bug
Projects
None yet
Milestone
v1.14.0
Development

Successfully merging a pull request may close this issue.

West documentation for v1.14 mbolivar/zephyr
1 participant
@mbolivar