Skip to content

West patch lacks documentation #89215

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
Open
matt-wood-ct opened this issue Apr 28, 2025 · 3 comments · May be fixed by #89748
Open

West patch lacks documentation #89215

matt-wood-ct opened this issue Apr 28, 2025 · 3 comments · May be fixed by #89748
Assignees
@cfriedt @pdgendt
Labels
area: Documentation area: West West utility Enhancement Changes/Updates/Additions to existing features

Comments

@matt-wood-ct
Copy link

Is your enhancement proposal related to a problem? Please describe.
There is no documentation beyond the CLI help for west patch, my team have been actively using zephyr for years and none of us noticed this feature even existed until today.
If we had known about it we would have had a much easier time handling WIP driver fixes, we previously took the whole drivers out of tree to tweak them while PRs were going through.

IMO This seems like a very good and very important feature, it deserves to be fully explained to users. The linking to PRs seems especially interesting.

Describe the solution you'd like
It would be nice to have a page or section in the west built-in commands documentation.

Describe alternatives you've considered
N/A

Additional context
Currently the best source on how to use this excellent feature is the discussion in the PR and the yaml schema file.
@matt-wood-ct matt-wood-ct added the Enhancement Changes/Updates/Additions to existing features label Apr 28, 2025
@nashif nashif added the area: West West utility label Apr 28, 2025
@pdgendt
Copy link
Collaborator

pdgendt commented Apr 29, 2025

This isn't a west built-in command, but a Zephyr extension and this can/should be added at https://github.com/zephyrproject-rtos/zephyr/blob/4d848ebdb1148794189661b7e5741c0f96ee22b8/doc/develop/west/zephyr-cmds.rst

@cfriedt
Copy link
Member

cfriedt commented May 1, 2025

I wish I understood the link-to-pr feature better. Perhaps the documentation can be updated collaboratively?

@cfriedt cfriedt linked a pull request May 9, 2025 that will close this issue
Open
@cfriedt
Copy link
Member

cfriedt commented May 9, 2025

I just went through west patch gh-fetch. It's ok.

It would be nice to be able to refer to a pull request inside the YAML directly as well, so that west patch apply would download, verify, and apply a patch series from a given PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@cfriedt cfriedt

@pdgendt pdgendt

Labels
area: Documentation area: West West utility Enhancement Changes/Updates/Additions to existing features
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

doc: west: add documentation for west patch cfriedt/zephyr
4 participants
@nashif @cfriedt @pdgendt @matt-wood-ct