Skip to content

Commit

Permalink
doc: samples: use :zephyr-app: for in-tree samples
Browse files Browse the repository at this point in the history
The zephyr-app-commands directive can output a helpful hint to the user
when they are trying to build a sample that is in the Zephyr tree,
telling them to ensure they are in the root folder of the Zephyr repo.

Update all doc pages that were using :app: instead of :zephyr-app: so
that the hint is displayed.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
  • Loading branch information
kartben authored and nashif committed Sep 5, 2024
1 parent 0d25e30 commit 34982bb
Show file tree
Hide file tree
Showing 46 changed files with 62 additions and 62 deletions.
2 changes: 1 addition & 1 deletion boards/01space/esp32c3_042_oled/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ To build the sample application using sysbuild, use this command:

.. zephyr-app-commands::
:tool: west
:app: samples/hello_world
:zephyr-app: samples/hello_world
:board: esp32c3_042_oled
:goals: build
:west-args: --sysbuild
Expand Down
2 changes: 1 addition & 1 deletion boards/ct/ctcc/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ Zephyr repositories using :ref:`west` tool.
#. Flash other Zephyr application to fill in slot0 e.g:

.. zephyr-app-commands::
:app: samples/subsys/usb/dfu
:zephyr-app: samples/subsys/usb/dfu
:board: ctcc/nrf52840
:build-dir: dfu
:goals: build
Expand Down
2 changes: 1 addition & 1 deletion boards/espressif/esp32_devkitc_wroom/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ To build the sample application using sysbuild use the command:

.. zephyr-app-commands::
:tool: west
:app: samples/hello_world
:zephyr-app: samples/hello_world
:board: esp_wrover_kit
:goals: build
:west-args: --sysbuild
Expand Down
2 changes: 1 addition & 1 deletion boards/espressif/esp32_devkitc_wrover/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ To build the sample application using sysbuild use the command:

.. zephyr-app-commands::
:tool: west
:app: samples/hello_world
:zephyr-app: samples/hello_world
:board: esp32_devkitc_wrover
:goals: build
:west-args: --sysbuild
Expand Down
2 changes: 1 addition & 1 deletion boards/espressif/esp32_ethernet_kit/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -478,7 +478,7 @@ To build the sample application using sysbuild use the command:

.. zephyr-app-commands::
:tool: west
:app: samples/hello_world
:zephyr-app: samples/hello_world
:board: esp32_ethernet_kit/esp32/procpu
:goals: build
:west-args: --sysbuild
Expand Down
2 changes: 1 addition & 1 deletion boards/espressif/esp32c3_devkitc/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ To build the sample application using sysbuild use the command:

.. zephyr-app-commands::
:tool: west
:app: samples/hello_world
:zephyr-app: samples/hello_world
:board: esp32c3_devkitc
:goals: build
:west-args: --sysbuild
Expand Down
2 changes: 1 addition & 1 deletion boards/espressif/esp32c3_devkitm/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ To build the sample application using sysbuild use the command:

.. zephyr-app-commands::
:tool: west
:app: samples/hello_world
:zephyr-app: samples/hello_world
:board: esp32c3_devkitm
:goals: build
:west-args: --sysbuild
Expand Down
2 changes: 1 addition & 1 deletion boards/espressif/esp32c3_rust/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ To build the sample application using sysbuild use the command:

.. zephyr-app-commands::
:tool: west
:app: samples/hello_world
:zephyr-app: samples/hello_world
:board: esp32c3_rust
:goals: build
:west-args: --sysbuild
Expand Down
2 changes: 1 addition & 1 deletion boards/espressif/esp32c6_devkitc/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ To build the sample application using sysbuild use the command:

.. zephyr-app-commands::
:tool: west
:app: samples/hello_world
:zephyr-app: samples/hello_world
:board: esp32c6_devkitc
:goals: build
:west-args: --sysbuild
Expand Down
2 changes: 1 addition & 1 deletion boards/espressif/esp32s2_devkitc/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ To build the sample application using sysbuild use the command:

.. zephyr-app-commands::
:tool: west
:app: samples/hello_world
:zephyr-app: samples/hello_world
:board: esp32s2_devkitc
:goals: build
:west-args: --sysbuild
Expand Down
2 changes: 1 addition & 1 deletion boards/espressif/esp32s2_saola/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ To build the sample application using sysbuild use the command:

.. zephyr-app-commands::
:tool: west
:app: samples/hello_world
:zephyr-app: samples/hello_world
:board: esp32s2_saola
:goals: build
:west-args: --sysbuild
Expand Down
2 changes: 1 addition & 1 deletion boards/espressif/esp32s3_devkitc/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ To build the sample application using sysbuild use the command:

.. zephyr-app-commands::
:tool: west
:app: samples/hello_world
:zephyr-app: samples/hello_world
:board: esp32s3_devkitc/esp32s3/procpu
:goals: build
:west-args: --sysbuild
Expand Down
2 changes: 1 addition & 1 deletion boards/espressif/esp32s3_devkitm/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ To build the sample application using sysbuild use the command:

.. zephyr-app-commands::
:tool: west
:app: samples/hello_world
:zephyr-app: samples/hello_world
:board: esp32s3_devkitm
:goals: build
:west-args: --sysbuild
Expand Down
2 changes: 1 addition & 1 deletion boards/espressif/esp8684_devkitm/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ To build the sample application using sysbuild use the command:

.. zephyr-app-commands::
:tool: west
:app: samples/hello_world
:zephyr-app: samples/hello_world
:board: esp8684_devkitm
:goals: build
:west-args: --sysbuild
Expand Down
2 changes: 1 addition & 1 deletion boards/espressif/esp_wrover_kit/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -542,7 +542,7 @@ To build the sample application using sysbuild use the command:

.. zephyr-app-commands::
:tool: west
:app: samples/hello_world
:zephyr-app: samples/hello_world
:board: esp_wrover_kit
:goals: build
:west-args: --sysbuild
Expand Down
2 changes: 1 addition & 1 deletion boards/franzininho/esp32s2_franzininho/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ To build the sample application using sysbuild use the command:

.. zephyr-app-commands::
:tool: west
:app: samples/hello_world
:zephyr-app: samples/hello_world
:board: esp32s2_franzininho
:goals: build
:west-args: --sysbuild
Expand Down
2 changes: 1 addition & 1 deletion boards/hardkernel/odroid_go/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ To build the sample application using sysbuild use the command:

.. zephyr-app-commands::
:tool: west
:app: samples/hello_world
:zephyr-app: samples/hello_world
:board: odroid_go
:goals: build
:west-args: --sysbuild
Expand Down
2 changes: 1 addition & 1 deletion boards/heltec/heltec_wifi_lora32_v2/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ To build the sample application using sysbuild use the command:

.. zephyr-app-commands::
:tool: west
:app: samples/hello_world
:zephyr-app: samples/hello_world
:board: heltec_wifi_lora32_v2
:goals: build
:west-args: --sysbuild
Expand Down
2 changes: 1 addition & 1 deletion boards/heltec/heltec_wireless_stick_lite_v3/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ To build the sample application using sysbuild use the command:

.. zephyr-app-commands::
:tool: west
:app: samples/hello_world
:zephyr-app: samples/hello_world
:board: heltec_wireless_stick_lite_v3
:goals: build
:west-args: --sysbuild
Expand Down
6 changes: 3 additions & 3 deletions boards/lilygo/ttgo_lora32/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ To build the sample application using sysbuild use the command:

.. zephyr-app-commands::
:tool: west
:app: samples/hello_world
:zephyr-app: samples/hello_world
:board: ttgo_lora32/esp32/procpu
:goals: build
:west-args: --sysbuild
Expand Down Expand Up @@ -214,7 +214,7 @@ To build the LoRa transmit sample application using sysbuild use the command:

.. zephyr-app-commands::
:tool: west
:app: samples/drivers/lora/send
:zephyr-app: samples/drivers/lora/send
:board: ttgo_lora32/esp32/procpu
:goals: build
:west-args: --sysbuild
Expand All @@ -224,7 +224,7 @@ To build the LoRa receive sample application using sysbuild use the command:

.. zephyr-app-commands::
:tool: west
:app: samples/drivers/lora/receive
:zephyr-app: samples/drivers/lora/receive
:board: ttgo_lora32/esp32/procpu
:goals: build
:west-args: --sysbuild
Expand Down
6 changes: 3 additions & 3 deletions boards/lilygo/ttgo_t8c3/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ To build the sample application using sysbuild use the command:

.. zephyr-app-commands::
:tool: west
:app: samples/hello_world
:zephyr-app: samples/hello_world
:board: ttgo_t8c3
:goals: build
:west-args: --sysbuild
Expand Down Expand Up @@ -212,15 +212,15 @@ To build the blinky sample:

.. zephyr-app-commands::
:tool: west
:app: samples/basic/blinky
:zephyr-app: samples/basic/blinky
:board: ttgo_t8c3
:goals: build

To build the bluetooth beacon sample:

.. zephyr-app-commands::
:tool: west
:app: samples/bluetooth/beacon
:zephyr-app: samples/bluetooth/beacon
:board: ttgo_t8c3
:goals: build

Expand Down
2 changes: 1 addition & 1 deletion boards/luatos/esp32c3_luatos_core/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ To build the sample application using sysbuild use the command:

.. zephyr-app-commands::
:tool: west
:app: samples/hello_world
:zephyr-app: samples/hello_world
:board: esp32c3_luatos_core
:goals: build
:west-args: --sysbuild
Expand Down
2 changes: 1 addition & 1 deletion boards/luatos/esp32s3_luatos_core/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ To build the sample application using sysbuild use the command:

.. zephyr-app-commands::
:tool: west
:app: samples/hello_world
:zephyr-app: samples/hello_world
:board: esp32s3_luatos_core
:goals: build
:west-args: --sysbuild
Expand Down
2 changes: 1 addition & 1 deletion boards/m5stack/m5stickc_plus/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ To build the sample application using sysbuild use the command:

.. zephyr-app-commands::
:tool: west
:app: samples/hello_world
:zephyr-app: samples/hello_world
:board: m5stickc_plus
:goals: build
:west-args: --sysbuild
Expand Down
2 changes: 1 addition & 1 deletion boards/m5stack/stamp_c3/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ To build the sample application using sysbuild use the command:

.. zephyr-app-commands::
:tool: west
:app: samples/hello_world
:zephyr-app: samples/hello_world
:board: stamp_c3
:goals: build
:west-args: --sysbuild
Expand Down
2 changes: 1 addition & 1 deletion boards/olimex/olimex_esp32_evb/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ To build the sample application using sysbuild use the command:

.. zephyr-app-commands::
:tool: west
:app: samples/hello_world
:zephyr-app: samples/hello_world
:board: olimex_esp32_evb
:goals: build
:west-args: --sysbuild
Expand Down
2 changes: 1 addition & 1 deletion boards/others/icev_wireless/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ To build the sample application using sysbuild use the command:

.. zephyr-app-commands::
:tool: west
:app: samples/hello_world
:zephyr-app: samples/hello_world
:board: icev_wireless
:goals: build
:west-args: --sysbuild
Expand Down
2 changes: 1 addition & 1 deletion boards/seeed/xiao_esp32c3/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ To build the sample application using sysbuild use the command:

.. zephyr-app-commands::
:tool: west
:app: samples/hello_world
:zephyr-app: samples/hello_world
:board: xiao_esp32c3
:goals: build
:west-args: --sysbuild
Expand Down
2 changes: 1 addition & 1 deletion boards/seeed/xiao_esp32s3/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ To build the sample application using sysbuild use the command:

.. zephyr-app-commands::
:tool: west
:app: samples/hello_world
:zephyr-app: samples/hello_world
:board: xiao_esp32s3
:goals: build
:west-args: --sysbuild
Expand Down
2 changes: 1 addition & 1 deletion boards/vcc-gnd/yd_esp32/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ To build the sample application using sysbuild use the command:

.. zephyr-app-commands::
:tool: west
:app: samples/hello_world
:zephyr-app: samples/hello_world
:board: yd_esp32
:goals: build
:west-args: --sysbuild
Expand Down
8 changes: 4 additions & 4 deletions doc/build/sysbuild/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ As mentioned above, you can run sysbuild via ``west build`` or ``cmake``.

.. zephyr-app-commands::
:tool: west
:app: samples/hello_world
:zephyr-app: samples/hello_world
:board: reel_board
:goals: build
:west-args: --sysbuild
Expand Down Expand Up @@ -166,7 +166,7 @@ applying to both images debug optimizations:

.. zephyr-app-commands::
:tool: west
:app: samples/hello_world
:zephyr-app: samples/hello_world
:board: reel_board
:goals: build
:west-args: --sysbuild
Expand Down Expand Up @@ -316,7 +316,7 @@ enable MCUboot and build and flash the sample as follows:

.. zephyr-app-commands::
:tool: west
:app: samples/hello_world
:zephyr-app: samples/hello_world
:board: reel_board
:goals: build
:west-args: --sysbuild
Expand Down Expand Up @@ -381,7 +381,7 @@ specify this file when building with sysbuild, as follows:

.. zephyr-app-commands::
:tool: west
:app: samples/hello_world
:zephyr-app: samples/hello_world
:board: reel_board
:goals: build
:west-args: --sysbuild
Expand Down
4 changes: 2 additions & 2 deletions doc/develop/application/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -802,7 +802,7 @@ As an example, let's build the Hello World sample for the ``reel_board``:

.. zephyr-app-commands::
:tool: all
:app: samples/hello_world
:zephyr-app: samples/hello_world
:board: reel_board
:goals: build

Expand All @@ -820,7 +820,7 @@ Using CMake directly:

.. zephyr-app-commands::
:tool: cmake
:app: samples/hello_world
:zephyr-app: samples/hello_world
:generator: make
:host-os: unix
:board: reel_board
Expand Down
2 changes: 1 addition & 1 deletion doc/develop/beyond-GSG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@ a list of supported boards.
#. Build the blinky sample for the ``reel_board``:

.. zephyr-app-commands::
:app: samples/basic/blinky
:zephyr-app: samples/basic/blinky
:board: reel_board
:goals: build

Expand Down
2 changes: 1 addition & 1 deletion doc/develop/debug/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@ Generate and Import an Eclipse Project

.. zephyr-app-commands::
:tool: all
:app: %ZEPHYR_BASE%\samples\synchronization
:zephyr-app: samples\synchronization
:host-os: win
:board: frdm_k64f
:gen-args: -G"Eclipse CDT4 - Ninja"
Expand Down
Loading

0 comments on commit 34982bb

Please sign in to comment.