doc: west: Document west installation in-depth
Create a new dedicated section for west installation that details some of the finer aspects of the process and steps involved. Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
This commit is contained in:
parent
66fdd48fdd
commit
9cea26ae77
3 changed files with 100 additions and 2 deletions
|
@ -52,8 +52,9 @@ First, install the ``west`` binary and bootstrapper:
|
|||
pip3 install west
|
||||
|
||||
.. note::
|
||||
See :ref:`gs_python_deps` for additional clarfication on using the
|
||||
``--user`` switch.
|
||||
See :ref:`west-install` for additional details on installing west.
|
||||
|
||||
.. _clone-zephyr:
|
||||
|
||||
Clone the Zephyr Repositories
|
||||
=============================
|
||||
|
|
|
@ -33,6 +33,7 @@ context about the tool.
|
|||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
install.rst
|
||||
repo-tool.rst
|
||||
manifest.rst
|
||||
config.rst
|
||||
|
|
96
doc/guides/west/install.rst
Normal file
96
doc/guides/west/install.rst
Normal file
|
@ -0,0 +1,96 @@
|
|||
.. _west-install:
|
||||
|
||||
Installing west
|
||||
###############
|
||||
|
||||
West is written in Python 3 and distributed through `PyPI`_.
|
||||
Use :file:`pip3` to install or upgrade west:
|
||||
|
||||
On Linux::
|
||||
|
||||
pip3 install --user -U west
|
||||
|
||||
On Windows and macOS::
|
||||
|
||||
pip3 install -U west
|
||||
|
||||
.. note::
|
||||
See :ref:`gs_python_deps` for additional clarfication on using the
|
||||
``--user`` switch.
|
||||
|
||||
The following are the typical locations where the west files will be
|
||||
installed if you followed the instructions above:
|
||||
|
||||
.. tip::
|
||||
You can use the ``pip3 show -f west`` command to display information about
|
||||
the installed packaged, including file locations.
|
||||
|
||||
* Linux:
|
||||
|
||||
* Executable: :file:`~/.local/bin/west`
|
||||
* Package: :file:`~/.local/lib/python3.<x>/site-packages/west/`
|
||||
|
||||
* macOS:
|
||||
|
||||
* Executable: :file:`/usr/local/bin/west`
|
||||
* Package: :file:`/usr/local/lib/python3.<x>/site-packages/west/`
|
||||
|
||||
* Windows:
|
||||
|
||||
* Executable: :file:`C:\\Python3<x>\\Scripts\\west.exe`
|
||||
* Package: :file:`C:\\Python3<x>\\Lib\\site-packages\\west\\`
|
||||
|
||||
Once west is installed you can use it to :ref:`clone the Zephyr repositories
|
||||
<clone-zephyr>`.
|
||||
|
||||
.. _west-shell-completion:
|
||||
|
||||
Enabling shell completion
|
||||
*************************
|
||||
|
||||
West currently supports shell completion in the following combinations of
|
||||
platform and shell:
|
||||
|
||||
* Linux: bash
|
||||
* macOS: bash
|
||||
* Windows: not available
|
||||
|
||||
In order to enable shell completion, you will need to obtain the corresponding
|
||||
completion script and have it sourced every time you enter a new shell session.
|
||||
|
||||
To obtain the completion script you can use the ``west completion`` command::
|
||||
|
||||
cd ~
|
||||
west completion bash > west-completion.bash
|
||||
|
||||
.. note::
|
||||
Remember to update the completion script using ``west completion`` regularly
|
||||
to always have an up to date copy of it.
|
||||
|
||||
Next you need to have it sourced.
|
||||
|
||||
On Linux you have the following options:
|
||||
|
||||
* Copy :file:`west-completion.bash` to :file:`/etc/bash_completion.d/`
|
||||
* Copy :file:`west-completion.bash` to :file:`/usr/share/bash-completion/completions/`
|
||||
* Copy :file:`west-completion.bash` to a local folder and source it from your :file:`~/.bashrc`
|
||||
|
||||
On macOS you have the following options:
|
||||
|
||||
* Copy :file:`west-completion.bash` to a local folder and source it from your
|
||||
:file:`~/.bash_profile`
|
||||
* Install the ``bash-completion`` package with ``brew``::
|
||||
|
||||
brew install bash-completion
|
||||
|
||||
then source the main bash completion script in your :file:`~/.bash_profile`::
|
||||
|
||||
source /usr/local/etc/profile.d/bash_completion.sh
|
||||
|
||||
and finally copy :file:`west-completion.bash` to
|
||||
:file:`/usr/local/etc/bash_completion.d/`
|
||||
|
||||
|
||||
.. _PyPI:
|
||||
https://pypi.org/project/west/
|
||||
|
Loading…
Add table
Add a link
Reference in a new issue