michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: application: Document west outside workspace

Browse source 
Document that using west outside of a west workspace needs
ZEPHYR_BASE to be set. If this is not set, the instructions
on the "Application Development" page don't work.

Previously, "Getting Started Guide" and "Application Development"
pages told you to run `zephyr-env.sh/zephyr-env.cmd` which would
set ZEPHYR_BASE, but this was removed in Zephyr 2.3.0

Signed-off-by: Daniel Wong <drojfjord@gmail.com>
This commit is contained in:
Daniel Wong 2021-07-25 20:57:13 +10:00 • committed by Christopher Friedt
commit 14f09a3b00
1 changed files with 7 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

7
doc/application/index.rst
View file

@ -712,6 +712,13 @@ Using CMake directly:
Basics
======
.. note::
In the below example, ``west`` is used outside of a west workspace. For this
to work, you must set the ``ZEPHYR_BASE`` environment variable to the path
of your zephyr git repository, using one of the methods on the
:ref:`Environment Variables <env_vars>` page.
#. Navigate to the application directory :file:`<home>/app`.
#. Enter the following commands to build the application's :file:`zephyr.elf`
image for the board specified in the command-line parameters: