Skip to content

Commit 03a5860

Browse files
thorsten-kleincfriedt
authored andcommitted
doc: develop: west: config option build.dir-fmt
new format arguments for config option build.dir-fmt are documented accordingly. Signed-off-by: Thorsten Klein <thorsten.klein@bshg.com>
1 parent 5ee522e commit 03a5860

File tree

1 file changed

+16
-3
lines changed

1 file changed

+16
-3
lines changed

doc/develop/west/build-flash-debug.rst

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -395,10 +395,23 @@ You can :ref:`configure <west-config-cmd>` ``west build`` using these options.
395395
west whenever it needs to create or locate a build folder. The currently
396396
available arguments are:
397397

398+
- ``west_topdir``: The absolute path to the west workspace, as
399+
returned by the ``west_topdir`` command
398400
- ``board``: The board name
399-
- ``source_dir``: The relative path from the current working directory
400-
to the source directory. If the current working directory is inside
401-
the source directory this will be set to an empty string.
401+
- ``source_dir``: Path to the CMake source directory, relative to the
402+
current working directory. If the current working directory is
403+
inside the source directory, this is an empty string. If no source
404+
directory is specified, it defaults to current working directory.
405+
E.g. if ``west build ../app`` is run from ``<west_topdir>/app1``,
406+
``source_dir`` resolves to ``../app`` (which is the relative path
407+
to the current working dir).
408+
- ``source_dir_workspace``: Path to the source directory, relative to
409+
``west_topdir`` (if it is inside the workspace). Otherwise, it is
410+
relative to the filesystem root (``/`` on Unix, respectively
411+
``C:/`` on Windows).
412+
E.g. if ``west build ../app`` is run from ``<west_topdir>/app1``,
413+
``source_dir`` resolves to ``app`` (which is the relative path to
414+
the west workspace dir).
402415
- ``app``: The name of the source directory.
403416
* - ``build.generator``
404417
- String, default ``Ninja``. The `CMake Generator`_ to use to create a

0 commit comments

Comments
 (0)