michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: getting started: Use -U when installing west

Browse source 
For users that have an older version of west already installed, it is
useful to include `-U` in the getting started guide, otherwise the
instructions will fail to work depending on the state of the machine.

Fixes #18132

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
This commit is contained in:
Carles Cufi 2019-08-08 21:27:52 +02:00 • committed by Alberto Escolar
commit a8d17437a6
1 changed files with 7 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

9
doc/getting_started/index.rst
View file

@ -39,6 +39,11 @@ information about pip\ [#pip]_, including this `information on -\\-user`_.
- On Windows, see the Installing Packages information on ``--user`` if you - On Windows, see the Installing Packages information on ``--user`` if you
require using this option. require using this option.
On all operating systems, the ``-U`` flag installs or updates the package if the
package is already installed locally but a more recent version is available. It
is good practice to use this flag if the latest version of a package is
required.
Install the required tools Install the required tools
=========================== ===========================
@ -68,10 +73,10 @@ First, install ``west`` using ``pip3``:
.. code-block:: console .. code-block:: console
# Linux # Linux
pip3 install --user west pip3 install --user -U west
# macOS (Terminal) and Windows (cmd.exe) # macOS (Terminal) and Windows (cmd.exe)
pip3 install west pip3 install -U west
See :ref:`west-install` for additional details on installing west. See :ref:`west-install` for additional details on installing west.