Skip to content

Commit 4b3f896

Browse files
mbolivar-nordicioannisg
authored andcommitted
doc: getting_started: run west update after pulling zephyr
This is causing confusion. Signed-off-by: Marti Bolivar <[email protected]>
1 parent bce38ba commit 4b3f896

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

doc/getting_started/index.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,16 @@ Clone all of Zephyr's repositories in a new :file:`zephyrproject` directory:
9696
You can replace :file:`zephyrproject` with another directory name. West creates
9797
the directory if it doesn't exist. See :ref:`west-multi-repo` for more details.
9898

99+
.. important::
100+
101+
You need to run ``west update`` any time :file:`zephyr/west.yml` changes.
102+
This command keeps :ref:`modules` in the :file:`zephyrproject` folder in sync
103+
with the code in the zephyr repository, so they work correctly together.
104+
105+
Some examples when ``west update`` is needed are: whenever you
106+
pull the :file:`zephyr` repository, switch branches in it, or perform a ``git
107+
bisect`` inside of it.
108+
99109
.. warning::
100110

101111
Don't clone into a directory with spaces anywhere in the path.

0 commit comments

Comments
 (0)