From a8d17437a6b34fc6e7a9bbec7d7163eae3550fb5 Mon Sep 17 00:00:00 2001 From: Carles Cufi Date: Thu, 8 Aug 2019 21:27:52 +0200 Subject: [PATCH] doc: getting started: Use -U when installing west 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 --- doc/getting_started/index.rst | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/doc/getting_started/index.rst b/doc/getting_started/index.rst index e40b1b8cf57..93514f948c7 100644 --- a/doc/getting_started/index.rst +++ b/doc/getting_started/index.rst @@ -39,6 +39,11 @@ information about pip\ [#pip]_, including this `information on -\\-user`_. - On Windows, see the Installing Packages information on ``--user`` if you 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 =========================== @@ -68,10 +73,10 @@ First, install ``west`` using ``pip3``: .. code-block:: console # Linux - pip3 install --user west + pip3 install --user -U west # macOS (Terminal) and Windows (cmd.exe) - pip3 install west + pip3 install -U west See :ref:`west-install` for additional details on installing west.