doc: west: add documentation for west patch #89748
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
requested review from
carlescufi,
kartben,
nashif,
pdgendt and
swinslow
JarmouniA
reviewed
May 9, 2025
cfriedt
force-pushed
the
doc-for-west-patch
branch
from
ad74139 to
50f0476
Compare
cfriedt
force-pushed
the
doc-for-west-patch
branch
9 times, most recently
from
d288dd1 to
726bb86
Compare
Member
Author
|
pdgendt
previously approved these changes
May 11, 2025
Contributor
|
Thanks for doing this, this command is a important workflow tool which many people were likely unaware of |
cfriedt
commented
May 12, 2025
doc/develop/west/zephyr-cmds.rst
Outdated
Comment on lines
290
to
301
| The ``patch`` command allows users to apply patches to Zephyr or Zephyr modules | ||
| in a controlled manner that makes automation and tracking easier for external applications that | ||
| use the :ref:`T2 star topology <west-t2>`. | ||
|
|
||
| There are several sub-commands available: | ||
|
|
||
| * ``apply``: apply a patch to the Zephyr module or a module in the workspace. | ||
| * ``clean``: remove all patches that have been applied to the Zephyr module or a module in the | ||
| workspace. | ||
| * ``list``: list all patches that have been applied to the Zephyr module or a module in the | ||
| workspace. | ||
| * ``gh-fetch``: fetch patches from GitHub. |
Member
Author
There was a problem hiding this comment.
Ooo... I just noticed that this could probably be worded better.
Suggested change
| The ``patch`` command allows users to apply patches to Zephyr or Zephyr modules | |
| in a controlled manner that makes automation and tracking easier for external applications that | |
| use the :ref:`T2 star topology <west-t2>`. | |
| There are several sub-commands available: | |
| * ``apply``: apply a patch to the Zephyr module or a module in the workspace. | |
| * ``clean``: remove all patches that have been applied to the Zephyr module or a module in the | |
| workspace. | |
| * ``list``: list all patches that have been applied to the Zephyr module or a module in the | |
| workspace. | |
| * ``gh-fetch``: fetch patches from GitHub. | |
| The ``patch`` command allows users to apply patches to Zephyr or Zephyr modules | |
| in a controlled manner that makes automation and tracking easier for external applications that | |
| use the :ref:`T2 star topology <west-t2>`. | |
| There are several sub-commands available to manage patches for Zephyr or other modules in the workspace. | |
| * ``apply``: apply patches listed in ``patches.yml`` | |
| * ``clean``: remove all patches that have been applied, and reset to the manifest checkout state | |
| * ``list``: list all patches in ``patches.yml`` | |
| * ``gh-fetch``: fetch patches from a GitHub pull request |
cfriedt
force-pushed
the
doc-for-west-patch
branch
from
726bb86 to
05d8580
Compare
JarmouniA
reviewed
May 13, 2025
cfriedt
force-pushed
the
doc-for-west-patch
branch
from
05d8580 to
26bc584
Compare
JarmouniA
previously approved these changes
May 14, 2025
pdgendt
previously approved these changes
May 14, 2025
kartben
reviewed
May 14, 2025
cfriedt
force-pushed
the
doc-for-west-patch
branch
from
26bc584 to
81a9bd7
Compare
cfriedt
force-pushed
the
doc-for-west-patch
branch
from
81a9bd7 to
7a2ccf8
Compare
kartben
previously approved these changes
May 14, 2025
Add documentation for the `west patch` command. Signed-off-by: Chris Friedt <cfriedt@tenstorrent.com>
cfriedt
force-pushed
the
doc-for-west-patch
branch
from
7a2ccf8 to
7e77b0f
Compare
pdgendt
approved these changes
May 14, 2025
Member
Author
Sorry for the last minute change @kartben 😅 |
kartben
approved these changes
May 14, 2025
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add documentation for the
west patchcommand.Closes #89215
Doc Preview