From 34982bb00b57486aeb83a6cb3bb7433791302aed Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Benjamin=20Cab=C3=A9?= Date: Fri, 23 Aug 2024 18:00:28 +0200 Subject: [PATCH] doc: samples: use :zephyr-app: for in-tree samples MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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é --- boards/01space/esp32c3_042_oled/doc/index.rst | 2 +- boards/ct/ctcc/doc/index.rst | 2 +- boards/espressif/esp32_devkitc_wroom/doc/index.rst | 2 +- boards/espressif/esp32_devkitc_wrover/doc/index.rst | 2 +- boards/espressif/esp32_ethernet_kit/doc/index.rst | 2 +- boards/espressif/esp32c3_devkitc/doc/index.rst | 2 +- boards/espressif/esp32c3_devkitm/doc/index.rst | 2 +- boards/espressif/esp32c3_rust/doc/index.rst | 2 +- boards/espressif/esp32c6_devkitc/doc/index.rst | 2 +- boards/espressif/esp32s2_devkitc/doc/index.rst | 2 +- boards/espressif/esp32s2_saola/doc/index.rst | 2 +- boards/espressif/esp32s3_devkitc/doc/index.rst | 2 +- boards/espressif/esp32s3_devkitm/doc/index.rst | 2 +- boards/espressif/esp8684_devkitm/doc/index.rst | 2 +- boards/espressif/esp_wrover_kit/doc/index.rst | 2 +- boards/franzininho/esp32s2_franzininho/doc/index.rst | 2 +- boards/hardkernel/odroid_go/doc/index.rst | 2 +- boards/heltec/heltec_wifi_lora32_v2/doc/index.rst | 2 +- .../heltec/heltec_wireless_stick_lite_v3/doc/index.rst | 2 +- boards/lilygo/ttgo_lora32/doc/index.rst | 6 +++--- boards/lilygo/ttgo_t8c3/doc/index.rst | 6 +++--- boards/luatos/esp32c3_luatos_core/doc/index.rst | 2 +- boards/luatos/esp32s3_luatos_core/doc/index.rst | 2 +- boards/m5stack/m5stickc_plus/doc/index.rst | 2 +- boards/m5stack/stamp_c3/doc/index.rst | 2 +- boards/olimex/olimex_esp32_evb/doc/index.rst | 2 +- boards/others/icev_wireless/doc/index.rst | 2 +- boards/seeed/xiao_esp32c3/doc/index.rst | 2 +- boards/seeed/xiao_esp32s3/doc/index.rst | 2 +- boards/vcc-gnd/yd_esp32/doc/index.rst | 2 +- doc/build/sysbuild/index.rst | 8 ++++---- doc/develop/application/index.rst | 4 ++-- doc/develop/beyond-GSG.rst | 2 +- doc/develop/debug/index.rst | 2 +- doc/develop/optimizations/tools.rst | 10 +++++----- doc/hardware/emulator/bus_emulators.rst | 4 ++-- doc/security/hardening-tool.rst | 2 +- doc/services/debugging/thread-analyzer.rst | 2 +- doc/services/tfm/build.rst | 8 ++++---- doc/services/tracing/index.rst | 2 +- samples/boards/stm32/ccm/README.rst | 2 +- samples/boards/stm32/mco/README.rst | 2 +- samples/modules/canopennode/README.rst | 2 +- samples/sensor/vcnl4040/README.rst | 2 +- samples/sensor/vl53l0x/README.rst | 2 +- samples/sysbuild/with_mcuboot/README.rst | 2 +- 46 files changed, 62 insertions(+), 62 deletions(-) diff --git a/boards/01space/esp32c3_042_oled/doc/index.rst b/boards/01space/esp32c3_042_oled/doc/index.rst index df7bf11286cd77..b8f3cbe7bc9f59 100644 --- a/boards/01space/esp32c3_042_oled/doc/index.rst +++ b/boards/01space/esp32c3_042_oled/doc/index.rst @@ -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 diff --git a/boards/ct/ctcc/doc/index.rst b/boards/ct/ctcc/doc/index.rst index 17649370f3e1be..38987822b6e920 100644 --- a/boards/ct/ctcc/doc/index.rst +++ b/boards/ct/ctcc/doc/index.rst @@ -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 diff --git a/boards/espressif/esp32_devkitc_wroom/doc/index.rst b/boards/espressif/esp32_devkitc_wroom/doc/index.rst index 251450cfa37118..b0e62c3e73981b 100644 --- a/boards/espressif/esp32_devkitc_wroom/doc/index.rst +++ b/boards/espressif/esp32_devkitc_wroom/doc/index.rst @@ -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 diff --git a/boards/espressif/esp32_devkitc_wrover/doc/index.rst b/boards/espressif/esp32_devkitc_wrover/doc/index.rst index 1ea4a01983fd36..0d82e6e3979f4a 100644 --- a/boards/espressif/esp32_devkitc_wrover/doc/index.rst +++ b/boards/espressif/esp32_devkitc_wrover/doc/index.rst @@ -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 diff --git a/boards/espressif/esp32_ethernet_kit/doc/index.rst b/boards/espressif/esp32_ethernet_kit/doc/index.rst index 93639a269c4844..d4d7260904d2e0 100644 --- a/boards/espressif/esp32_ethernet_kit/doc/index.rst +++ b/boards/espressif/esp32_ethernet_kit/doc/index.rst @@ -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 diff --git a/boards/espressif/esp32c3_devkitc/doc/index.rst b/boards/espressif/esp32c3_devkitc/doc/index.rst index 4497ae83a035ae..6bcb06f71164e5 100644 --- a/boards/espressif/esp32c3_devkitc/doc/index.rst +++ b/boards/espressif/esp32c3_devkitc/doc/index.rst @@ -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 diff --git a/boards/espressif/esp32c3_devkitm/doc/index.rst b/boards/espressif/esp32c3_devkitm/doc/index.rst index c5c1e2b13c4747..53e1437be81d60 100644 --- a/boards/espressif/esp32c3_devkitm/doc/index.rst +++ b/boards/espressif/esp32c3_devkitm/doc/index.rst @@ -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 diff --git a/boards/espressif/esp32c3_rust/doc/index.rst b/boards/espressif/esp32c3_rust/doc/index.rst index a881f4c8dec5b5..4647376efa6ecb 100644 --- a/boards/espressif/esp32c3_rust/doc/index.rst +++ b/boards/espressif/esp32c3_rust/doc/index.rst @@ -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 diff --git a/boards/espressif/esp32c6_devkitc/doc/index.rst b/boards/espressif/esp32c6_devkitc/doc/index.rst index 6f72e4958cfd4b..c536798f5185ef 100644 --- a/boards/espressif/esp32c6_devkitc/doc/index.rst +++ b/boards/espressif/esp32c6_devkitc/doc/index.rst @@ -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 diff --git a/boards/espressif/esp32s2_devkitc/doc/index.rst b/boards/espressif/esp32s2_devkitc/doc/index.rst index 1fa0bc6606b811..8dc6407102f31c 100644 --- a/boards/espressif/esp32s2_devkitc/doc/index.rst +++ b/boards/espressif/esp32s2_devkitc/doc/index.rst @@ -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 diff --git a/boards/espressif/esp32s2_saola/doc/index.rst b/boards/espressif/esp32s2_saola/doc/index.rst index a18764e426a49f..711e8b02dfda99 100644 --- a/boards/espressif/esp32s2_saola/doc/index.rst +++ b/boards/espressif/esp32s2_saola/doc/index.rst @@ -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 diff --git a/boards/espressif/esp32s3_devkitc/doc/index.rst b/boards/espressif/esp32s3_devkitc/doc/index.rst index 0d9f142ac97281..bf9256892a2b86 100644 --- a/boards/espressif/esp32s3_devkitc/doc/index.rst +++ b/boards/espressif/esp32s3_devkitc/doc/index.rst @@ -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 diff --git a/boards/espressif/esp32s3_devkitm/doc/index.rst b/boards/espressif/esp32s3_devkitm/doc/index.rst index 95e073fd65a5fa..9e8d06f187998e 100644 --- a/boards/espressif/esp32s3_devkitm/doc/index.rst +++ b/boards/espressif/esp32s3_devkitm/doc/index.rst @@ -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 diff --git a/boards/espressif/esp8684_devkitm/doc/index.rst b/boards/espressif/esp8684_devkitm/doc/index.rst index d3541a29be5b5b..24a973279e2b9e 100644 --- a/boards/espressif/esp8684_devkitm/doc/index.rst +++ b/boards/espressif/esp8684_devkitm/doc/index.rst @@ -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 diff --git a/boards/espressif/esp_wrover_kit/doc/index.rst b/boards/espressif/esp_wrover_kit/doc/index.rst index 6c611c26016d70..2a2a12f871faf2 100644 --- a/boards/espressif/esp_wrover_kit/doc/index.rst +++ b/boards/espressif/esp_wrover_kit/doc/index.rst @@ -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 diff --git a/boards/franzininho/esp32s2_franzininho/doc/index.rst b/boards/franzininho/esp32s2_franzininho/doc/index.rst index 608c575796f118..b2d1a8f64336aa 100644 --- a/boards/franzininho/esp32s2_franzininho/doc/index.rst +++ b/boards/franzininho/esp32s2_franzininho/doc/index.rst @@ -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 diff --git a/boards/hardkernel/odroid_go/doc/index.rst b/boards/hardkernel/odroid_go/doc/index.rst index 26915a03a982f3..b0400a810230af 100644 --- a/boards/hardkernel/odroid_go/doc/index.rst +++ b/boards/hardkernel/odroid_go/doc/index.rst @@ -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 diff --git a/boards/heltec/heltec_wifi_lora32_v2/doc/index.rst b/boards/heltec/heltec_wifi_lora32_v2/doc/index.rst index 86313f9c272328..11ffd8227dc273 100644 --- a/boards/heltec/heltec_wifi_lora32_v2/doc/index.rst +++ b/boards/heltec/heltec_wifi_lora32_v2/doc/index.rst @@ -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 diff --git a/boards/heltec/heltec_wireless_stick_lite_v3/doc/index.rst b/boards/heltec/heltec_wireless_stick_lite_v3/doc/index.rst index a5985d26ddc907..824ed656345fd3 100644 --- a/boards/heltec/heltec_wireless_stick_lite_v3/doc/index.rst +++ b/boards/heltec/heltec_wireless_stick_lite_v3/doc/index.rst @@ -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 diff --git a/boards/lilygo/ttgo_lora32/doc/index.rst b/boards/lilygo/ttgo_lora32/doc/index.rst index d7eb90b18569a4..6814a66543fe68 100644 --- a/boards/lilygo/ttgo_lora32/doc/index.rst +++ b/boards/lilygo/ttgo_lora32/doc/index.rst @@ -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 @@ -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 @@ -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 diff --git a/boards/lilygo/ttgo_t8c3/doc/index.rst b/boards/lilygo/ttgo_t8c3/doc/index.rst index 7df6641a8f31e5..e4ad3978cef8f6 100644 --- a/boards/lilygo/ttgo_t8c3/doc/index.rst +++ b/boards/lilygo/ttgo_t8c3/doc/index.rst @@ -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 @@ -212,7 +212,7 @@ To build the blinky sample: .. zephyr-app-commands:: :tool: west - :app: samples/basic/blinky + :zephyr-app: samples/basic/blinky :board: ttgo_t8c3 :goals: build @@ -220,7 +220,7 @@ 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 diff --git a/boards/luatos/esp32c3_luatos_core/doc/index.rst b/boards/luatos/esp32c3_luatos_core/doc/index.rst index 9eb5c8bfbb86d0..5458a84ead51d5 100644 --- a/boards/luatos/esp32c3_luatos_core/doc/index.rst +++ b/boards/luatos/esp32c3_luatos_core/doc/index.rst @@ -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 diff --git a/boards/luatos/esp32s3_luatos_core/doc/index.rst b/boards/luatos/esp32s3_luatos_core/doc/index.rst index 6f3b5760bf7343..b8afea2040d19f 100644 --- a/boards/luatos/esp32s3_luatos_core/doc/index.rst +++ b/boards/luatos/esp32s3_luatos_core/doc/index.rst @@ -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 diff --git a/boards/m5stack/m5stickc_plus/doc/index.rst b/boards/m5stack/m5stickc_plus/doc/index.rst index 69149fd76f67fc..441c5128cdc435 100644 --- a/boards/m5stack/m5stickc_plus/doc/index.rst +++ b/boards/m5stack/m5stickc_plus/doc/index.rst @@ -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 diff --git a/boards/m5stack/stamp_c3/doc/index.rst b/boards/m5stack/stamp_c3/doc/index.rst index 422bc09d1b3164..becb110eec3f6c 100644 --- a/boards/m5stack/stamp_c3/doc/index.rst +++ b/boards/m5stack/stamp_c3/doc/index.rst @@ -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 diff --git a/boards/olimex/olimex_esp32_evb/doc/index.rst b/boards/olimex/olimex_esp32_evb/doc/index.rst index 9a2360f12bd26b..390d09cffd1e93 100644 --- a/boards/olimex/olimex_esp32_evb/doc/index.rst +++ b/boards/olimex/olimex_esp32_evb/doc/index.rst @@ -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 diff --git a/boards/others/icev_wireless/doc/index.rst b/boards/others/icev_wireless/doc/index.rst index d44595b575510c..32598b6e53f35a 100644 --- a/boards/others/icev_wireless/doc/index.rst +++ b/boards/others/icev_wireless/doc/index.rst @@ -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 diff --git a/boards/seeed/xiao_esp32c3/doc/index.rst b/boards/seeed/xiao_esp32c3/doc/index.rst index 58260c91f5979c..37bdbabc4e78f4 100644 --- a/boards/seeed/xiao_esp32c3/doc/index.rst +++ b/boards/seeed/xiao_esp32c3/doc/index.rst @@ -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 diff --git a/boards/seeed/xiao_esp32s3/doc/index.rst b/boards/seeed/xiao_esp32s3/doc/index.rst index dc86914eee4eb5..010a29470df246 100644 --- a/boards/seeed/xiao_esp32s3/doc/index.rst +++ b/boards/seeed/xiao_esp32s3/doc/index.rst @@ -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 diff --git a/boards/vcc-gnd/yd_esp32/doc/index.rst b/boards/vcc-gnd/yd_esp32/doc/index.rst index d145db5fa90fca..cef02b96e901db 100644 --- a/boards/vcc-gnd/yd_esp32/doc/index.rst +++ b/boards/vcc-gnd/yd_esp32/doc/index.rst @@ -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 diff --git a/doc/build/sysbuild/index.rst b/doc/build/sysbuild/index.rst index 5166e1d44827a9..1770d4eac175b3 100644 --- a/doc/build/sysbuild/index.rst +++ b/doc/build/sysbuild/index.rst @@ -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 @@ -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 @@ -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 @@ -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 diff --git a/doc/develop/application/index.rst b/doc/develop/application/index.rst index 5b0878ef5b51f9..fff35bb5e83344 100644 --- a/doc/develop/application/index.rst +++ b/doc/develop/application/index.rst @@ -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 @@ -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 diff --git a/doc/develop/beyond-GSG.rst b/doc/develop/beyond-GSG.rst index 921cc992912aa7..cc5e770cd6a473 100644 --- a/doc/develop/beyond-GSG.rst +++ b/doc/develop/beyond-GSG.rst @@ -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 diff --git a/doc/develop/debug/index.rst b/doc/develop/debug/index.rst index a7afdab8c31d56..0e163241472698 100644 --- a/doc/develop/debug/index.rst +++ b/doc/develop/debug/index.rst @@ -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" diff --git a/doc/develop/optimizations/tools.rst b/doc/develop/optimizations/tools.rst index 4f36051031a81c..96bfac58c2872e 100644 --- a/doc/develop/optimizations/tools.rst +++ b/doc/develop/optimizations/tools.rst @@ -54,7 +54,7 @@ If you are using :ref:`sysbuild`, see :ref:`sysbuild_dedicated_image_build_targe .. zephyr-app-commands:: :tool: all - :app: samples/hello_world + :zephyr-app: samples/hello_world :board: reel_board :goals: ram_report @@ -116,7 +116,7 @@ If you are using :ref:`sysbuild`, see :ref:`sysbuild_dedicated_image_build_targe .. zephyr-app-commands:: :tool: all - :app: samples/hello_world + :zephyr-app: samples/hello_world :board: reel_board :goals: rom_report @@ -182,7 +182,7 @@ If you are using :ref:`sysbuild`, see :ref:`sysbuild_dedicated_image_build_targe .. zephyr-app-commands:: :tool: all - :app: samples/hello_world + :zephyr-app: samples/hello_world :board: reel_board :goals: puncover @@ -192,7 +192,7 @@ To view worst-case stack usage analysis, build this with the .. zephyr-app-commands:: :tool: all - :app: samples/hello_world + :zephyr-app: samples/hello_world :board: reel_board :goals: puncover :gen-args: -DCONFIG_STACK_USAGE=y @@ -227,7 +227,7 @@ If you are using :ref:`sysbuild`, see :ref:`sysbuild_dedicated_image_build_targe .. zephyr-app-commands:: :tool: all - :app: samples/hello_world + :zephyr-app: samples/hello_world :board: reel_board :goals: pahole diff --git a/doc/hardware/emulator/bus_emulators.rst b/doc/hardware/emulator/bus_emulators.rst index 87e18fef8e8731..ffe7730fd80053 100644 --- a/doc/hardware/emulator/bus_emulators.rst +++ b/doc/hardware/emulator/bus_emulators.rst @@ -184,7 +184,7 @@ Here are some examples present in Zephyr: #. Bosch BMI160 sensor driver connected via both I2C and SPI to an emulator: .. zephyr-app-commands:: - :app: tests/drivers/sensor/accel/ + :zephyr-app: tests/drivers/sensor/accel/ :board: native_sim :goals: build @@ -192,7 +192,7 @@ Here are some examples present in Zephyr: connected via I2C an emulator: .. zephyr-app-commands:: - :app: tests/drivers/eeprom/api + :zephyr-app: tests/drivers/eeprom/api :board: native_sim :goals: build :gen-args: -DDTC_OVERLAY_FILE=at2x_emul.overlay -DOVERLAY_CONFIG=at2x_emul.conf diff --git a/doc/security/hardening-tool.rst b/doc/security/hardening-tool.rst index c34ee2ceb662c4..7b69193ce36e72 100644 --- a/doc/security/hardening-tool.rst +++ b/doc/security/hardening-tool.rst @@ -25,7 +25,7 @@ Usage .. zephyr-app-commands:: :tool: all - :app: samples/hello_world + :zephyr-app: samples/hello_world :board: reel_board :goals: hardenconfig diff --git a/doc/services/debugging/thread-analyzer.rst b/doc/services/debugging/thread-analyzer.rst index ca5ae6f6e49745..2b41099df028aa 100644 --- a/doc/services/debugging/thread-analyzer.rst +++ b/doc/services/debugging/thread-analyzer.rst @@ -14,7 +14,7 @@ For example, to build the synchronization sample with Thread Analyser enabled, do the following: .. zephyr-app-commands:: - :app: samples/synchronization/ + :zephyr-app: samples/synchronization/ :board: qemu_x86 :goals: build :gen-args: -DCONFIG_QEMU_ICOUNT=n -DCONFIG_THREAD_ANALYZER=y \ diff --git a/doc/services/tfm/build.rst b/doc/services/tfm/build.rst index 985d9d76145534..3575ecc3a890a3 100644 --- a/doc/services/tfm/build.rst +++ b/doc/services/tfm/build.rst @@ -145,7 +145,7 @@ Use the ``tfm_ram_report`` to get the RAM report for TF-M secure firmware (tfm_s .. zephyr-app-commands:: :tool: all - :app: samples/hello_world + :zephyr-app: samples/hello_world :board: mps2_an521_ns :goals: tfm_ram_report @@ -153,7 +153,7 @@ Use the ``tfm_rom_report`` to get the ROM report for TF-M secure firmware (tfm_s .. zephyr-app-commands:: :tool: all - :app: samples/hello_world + :zephyr-app: samples/hello_world :board: mps2_an521_ns :goals: tfm_rom_report @@ -161,7 +161,7 @@ Use the ``bl2_ram_report`` to get the RAM report for TF-M MCUboot, if enabled. .. zephyr-app-commands:: :tool: all - :app: samples/hello_world + :zephyr-app: samples/hello_world :board: mps2_an521_ns :goals: bl2_ram_report @@ -169,6 +169,6 @@ Use the ``bl2_rom_report`` to get the ROM report for TF-M MCUboot, if enabled. .. zephyr-app-commands:: :tool: all - :app: samples/hello_world + :zephyr-app: samples/hello_world :board: mps2_an521_ns :goals: bl2_rom_report diff --git a/doc/services/tracing/index.rst b/doc/services/tracing/index.rst index 51ed14e5e5b0a1..17552781c32348 100644 --- a/doc/services/tracing/index.rst +++ b/doc/services/tracing/index.rst @@ -464,7 +464,7 @@ port, build the sample as follows: .. zephyr-app-commands:: :tool: all - :app: samples/subsys/tracing + :zephyr-app: samples/subsys/tracing :board: native_sim :gen-args: -DCONF_FILE=prj_native_ctf.conf :goals: build diff --git a/samples/boards/stm32/ccm/README.rst b/samples/boards/stm32/ccm/README.rst index 76959722d7a742..4c0a04b8bc2bf2 100644 --- a/samples/boards/stm32/ccm/README.rst +++ b/samples/boards/stm32/ccm/README.rst @@ -43,7 +43,7 @@ Building and Running ******************** .. zephyr-app-commands:: - :app: samples/boards/stm32/ccm + :zephyr-app: samples/boards/stm32/ccm :goals: build flash The first time the example is run after power on, the output will diff --git a/samples/boards/stm32/mco/README.rst b/samples/boards/stm32/mco/README.rst index d3989d47b42d34..1fd10ac2ccc988 100644 --- a/samples/boards/stm32/mco/README.rst +++ b/samples/boards/stm32/mco/README.rst @@ -21,7 +21,7 @@ Building and Running ******************** .. zephyr-app-commands:: - :app: samples/boards/stm32/mco + :zephyr-app: samples/boards/stm32/mco :board: nucleo_u5a5zj_q :goals: build flash diff --git a/samples/modules/canopennode/README.rst b/samples/modules/canopennode/README.rst index 1af064efe13456..aa88cb861c1993 100644 --- a/samples/modules/canopennode/README.rst +++ b/samples/modules/canopennode/README.rst @@ -405,7 +405,7 @@ for the FRDM-K64F as follows: .. zephyr-app-commands:: :tool: west - :app: samples/modules/canopennode + :zephyr-app: samples/modules/canopennode :board: frdm_k64f :goals: build :west-args: --sysbuild diff --git a/samples/sensor/vcnl4040/README.rst b/samples/sensor/vcnl4040/README.rst index 3546912896fdc4..26794839da3d33 100644 --- a/samples/sensor/vcnl4040/README.rst +++ b/samples/sensor/vcnl4040/README.rst @@ -30,7 +30,7 @@ Building and Running sensor to be connected to the desired board. .. zephyr-app-commands:: - :app: samples/sensor/vcnl4040/ + :zephyr-app: samples/sensor/vcnl4040/ :goals: build flash diff --git a/samples/sensor/vl53l0x/README.rst b/samples/sensor/vl53l0x/README.rst index 46d4ee8bb3b2fc..53f4bc9e1f9197 100644 --- a/samples/sensor/vl53l0x/README.rst +++ b/samples/sensor/vl53l0x/README.rst @@ -28,7 +28,7 @@ Building and Running sensor, which is present on the disco_l475_iot1 board. .. zephyr-app-commands:: - :app: samples/sensor/vl53l0x/ + :zephyr-app: samples/sensor/vl53l0x/ :goals: build flash diff --git a/samples/sysbuild/with_mcuboot/README.rst b/samples/sysbuild/with_mcuboot/README.rst index 2f9078cab9c761..e814eb1ffb31fc 100644 --- a/samples/sysbuild/with_mcuboot/README.rst +++ b/samples/sysbuild/with_mcuboot/README.rst @@ -32,7 +32,7 @@ To build both the sample and MCUboot with ``west`` for the ``reel_board``, run: .. zephyr-app-commands:: :tool: west - :app: samples/application_development/sysbuild/with_mcuboot + :zephyr-app: samples/application_development/sysbuild/with_mcuboot :board: reel_board :goals: build :west-args: --sysbuild