@@ -59,6 +59,18 @@ Additional information about west's structure can be found
59
59
Clone the Zephyr Repositories
60
60
=============================
61
61
62
+ .. warning ::
63
+ If you have run ``source zephyr-env.sh `` (on Linux or macOS) or
64
+ ``zephyr-env.cmd `` (on Windows) on a clone of zephyr that predates the
65
+ introduction of west, then the copy of west included in the clone will
66
+ override the bootstrapper installed with ``pip ``. In that case close the
67
+ shell and open a new one in order to remove it from the ``PATH ``. You
68
+ can check which ``west `` is being executed by running::
69
+
70
+ west --version
71
+
72
+ You should see ``West bootstrapper version: v0.5.0 `` (or higher).
73
+
62
74
Clone the Zephyr source code repositories from GitHub using the ``west `` tool:
63
75
64
76
.. code-block :: console
@@ -75,19 +87,22 @@ Clone the Zephyr source code repositories from GitHub using the ``west`` tool:
75
87
76
88
.. note ::
77
89
If you had previously cloned the zephyr repository manually using Git,
78
- move the cloned :file: `zephyr/ ` repository to an empty enclosing folder
79
- (for example :file: `zephyrproject/zephyr/ `), and
80
- from this enclosing folder :file: `zephyrproject/ ` run::
90
+ create an empty enclosing folder (for example :file: `zephyrproject/ `),
91
+ and move the cloned repository into it. From the enclosing folder run::
81
92
82
93
west init -l zephyr/
83
94
west update
84
95
85
96
The ``-l <path to zephyr> `` parameter instructs ``west `` to use an existing
86
- local copy instead of cloning a remote repository.
87
-
88
- This will create a full Zephyr local copy, cloning west itself along with any
89
- projects (i.e. remote repositories) required by Zephyr. See
90
- :ref: `west-struct-installation ` for additional details.
97
+ local copy instead of cloning a remote repository. This will create a full
98
+ Zephyr installation (see below).
99
+
100
+ Running ``west init `` will clone west itself into ``./.west/west `` and
101
+ initialize a local installation. Running ``west update `` will pull all the
102
+ projects referenced by the manifest file (:file: `zephyr/west.yml `) into the
103
+ folders specified in it. See :ref: `west-struct-installation ` for additional
104
+ details and a list of the folders and files that west will create as part of
105
+ the process.
91
106
92
107
.. warning ::
93
108
0 commit comments