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

Documentation: How to update Zephyr itself (with west) #32234

Closed
dueringa opened this issue Feb 11, 2021 · 2 comments · Fixed by #32284
Closed

Documentation: How to update Zephyr itself (with west) #32234

dueringa opened this issue Feb 11, 2021 · 2 comments · Fixed by #32284
Labels
area: Documentation Enhancement Changes/Updates/Additions to existing features

Comments

@dueringa
Copy link
Contributor

Current state
Currently, the "Getting started Guide" only mentions the initial fetch of Zephyr with west init / west update. The "Beyond the Getting Started Guide" briefly mentions that

The west update command fetches and keeps Modules (External projects) in the zephyrproject folder in sync with the code in the local zephyr repo.
Warning
You must run west update any time the zephyr/west.yml changes, caused, for example, when you pull the zephyr repository, switch branches in it, or perform a git bisect inside of it.

Suggestion
I'd actually like the documentation making it more explicit "How to update Zephyr". Something along the lines of

Running west update doesn't actually update Zephyr. It only keeps the modules in a known state (as specified by the West manifest file.)
To actually update Zephyr.
cd <base>/zephyrproject/zephyr, followed by a git pull.
After that, run west update [...]

@dueringa dueringa added the Enhancement Changes/Updates/Additions to existing features label Feb 11, 2021
@carlescufi
Copy link
Member

@dueringa perhaps you would consider sending a Pull Request against the corresponding .rst files in doc/?

@dueringa
Copy link
Contributor Author

@carlescufi I can do that. Just wanted to check if my understanding was correct, first

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: Documentation Enhancement Changes/Updates/Additions to existing features
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants