Browse Source

doc: develop: tools: update "Generate compile commands" section

Clarify that commands should be run from `zephyr` folder.

Fixes zephyrproject-rtos/zephyr#90074

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
pull/87630/head
Benjamin Cabé 4 weeks ago committed by Benjamin Cabé
parent
commit
8fb5b00f8d
  1. 14
      doc/develop/tools/vscode.rst

14
doc/develop/tools/vscode.rst

@ -45,13 +45,15 @@ Generate compile commands @@ -45,13 +45,15 @@ Generate compile commands
In order to support code navigation and linting capabilities, you must compile your project once to
generate the :file:`compile_commands.json` file that will provide the C/C++ extension with the
required information (ex. include paths):
required information (ex. include paths). You may do it from VS Code embedded terminal; select
:menuselection:`Terminal --> New Terminal` from the top menu or the command palette
(:kbd:`Ctrl+Shift+P`), then type:
.. code-block:: console
$ cd zephyr
$ west build -p always -b native_sim/native/64
.. zephyr-app-commands::
:zephyr-app: samples/basic/blinky
:board: native_sim/native/64
:goals: build
:compact:
Configure the C/C++ extension
*****************************

Loading…
Cancel
Save