Skip to content

Commit 34982bb

Browse files
kartbennashif
kartben
authored and
nashif
committed
doc: samples: use :zephyr-app: for in-tree samples
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é <[email protected]>
1 parent 0d25e30 commit 34982bb

File tree

46 files changed

+62
-62
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+62
-62
lines changed

‎boards/01space/esp32c3_042_oled/doc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ To build the sample application using sysbuild, use this command:
130130

131131
.. zephyr-app-commands::
132132
:tool: west
133-
:app: samples/hello_world
133+
:zephyr-app: samples/hello_world
134134
:board: esp32c3_042_oled
135135
:goals: build
136136
:west-args: --sysbuild

‎boards/ct/ctcc/doc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ Zephyr repositories using :ref:`west` tool.
155155
#. Flash other Zephyr application to fill in slot0 e.g:
156156

157157
.. zephyr-app-commands::
158-
:app: samples/subsys/usb/dfu
158+
:zephyr-app: samples/subsys/usb/dfu
159159
:board: ctcc/nrf52840
160160
:build-dir: dfu
161161
:goals: build

‎boards/espressif/esp32_devkitc_wroom/doc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ To build the sample application using sysbuild use the command:
156156

157157
.. zephyr-app-commands::
158158
:tool: west
159-
:app: samples/hello_world
159+
:zephyr-app: samples/hello_world
160160
:board: esp_wrover_kit
161161
:goals: build
162162
:west-args: --sysbuild

‎boards/espressif/esp32_devkitc_wrover/doc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ To build the sample application using sysbuild use the command:
156156

157157
.. zephyr-app-commands::
158158
:tool: west
159-
:app: samples/hello_world
159+
:zephyr-app: samples/hello_world
160160
:board: esp32_devkitc_wrover
161161
:goals: build
162162
:west-args: --sysbuild

‎boards/espressif/esp32_ethernet_kit/doc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -478,7 +478,7 @@ To build the sample application using sysbuild use the command:
478478

479479
.. zephyr-app-commands::
480480
:tool: west
481-
:app: samples/hello_world
481+
:zephyr-app: samples/hello_world
482482
:board: esp32_ethernet_kit/esp32/procpu
483483
:goals: build
484484
:west-args: --sysbuild

‎boards/espressif/esp32c3_devkitc/doc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ To build the sample application using sysbuild use the command:
131131

132132
.. zephyr-app-commands::
133133
:tool: west
134-
:app: samples/hello_world
134+
:zephyr-app: samples/hello_world
135135
:board: esp32c3_devkitc
136136
:goals: build
137137
:west-args: --sysbuild

‎boards/espressif/esp32c3_devkitm/doc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ To build the sample application using sysbuild use the command:
131131

132132
.. zephyr-app-commands::
133133
:tool: west
134-
:app: samples/hello_world
134+
:zephyr-app: samples/hello_world
135135
:board: esp32c3_devkitm
136136
:goals: build
137137
:west-args: --sysbuild

‎boards/espressif/esp32c3_rust/doc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,7 @@ To build the sample application using sysbuild use the command:
176176

177177
.. zephyr-app-commands::
178178
:tool: west
179-
:app: samples/hello_world
179+
:zephyr-app: samples/hello_world
180180
:board: esp32c3_rust
181181
:goals: build
182182
:west-args: --sysbuild

‎boards/espressif/esp32c6_devkitc/doc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ To build the sample application using sysbuild use the command:
167167

168168
.. zephyr-app-commands::
169169
:tool: west
170-
:app: samples/hello_world
170+
:zephyr-app: samples/hello_world
171171
:board: esp32c6_devkitc
172172
:goals: build
173173
:west-args: --sysbuild

‎boards/espressif/esp32s2_devkitc/doc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ To build the sample application using sysbuild use the command:
127127

128128
.. zephyr-app-commands::
129129
:tool: west
130-
:app: samples/hello_world
130+
:zephyr-app: samples/hello_world
131131
:board: esp32s2_devkitc
132132
:goals: build
133133
:west-args: --sysbuild

‎boards/espressif/esp32s2_saola/doc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ To build the sample application using sysbuild use the command:
127127

128128
.. zephyr-app-commands::
129129
:tool: west
130-
:app: samples/hello_world
130+
:zephyr-app: samples/hello_world
131131
:board: esp32s2_saola
132132
:goals: build
133133
:west-args: --sysbuild

‎boards/espressif/esp32s3_devkitc/doc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,7 @@ To build the sample application using sysbuild use the command:
176176

177177
.. zephyr-app-commands::
178178
:tool: west
179-
:app: samples/hello_world
179+
:zephyr-app: samples/hello_world
180180
:board: esp32s3_devkitc/esp32s3/procpu
181181
:goals: build
182182
:west-args: --sysbuild

‎boards/espressif/esp32s3_devkitm/doc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,7 @@ To build the sample application using sysbuild use the command:
176176

177177
.. zephyr-app-commands::
178178
:tool: west
179-
:app: samples/hello_world
179+
:zephyr-app: samples/hello_world
180180
:board: esp32s3_devkitm
181181
:goals: build
182182
:west-args: --sysbuild

‎boards/espressif/esp8684_devkitm/doc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ To build the sample application using sysbuild use the command:
126126

127127
.. zephyr-app-commands::
128128
:tool: west
129-
:app: samples/hello_world
129+
:zephyr-app: samples/hello_world
130130
:board: esp8684_devkitm
131131
:goals: build
132132
:west-args: --sysbuild

‎boards/espressif/esp_wrover_kit/doc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -542,7 +542,7 @@ To build the sample application using sysbuild use the command:
542542

543543
.. zephyr-app-commands::
544544
:tool: west
545-
:app: samples/hello_world
545+
:zephyr-app: samples/hello_world
546546
:board: esp_wrover_kit
547547
:goals: build
548548
:west-args: --sysbuild

‎boards/franzininho/esp32s2_franzininho/doc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ To build the sample application using sysbuild use the command:
9494

9595
.. zephyr-app-commands::
9696
:tool: west
97-
:app: samples/hello_world
97+
:zephyr-app: samples/hello_world
9898
:board: esp32s2_franzininho
9999
:goals: build
100100
:west-args: --sysbuild

‎boards/hardkernel/odroid_go/doc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ To build the sample application using sysbuild use the command:
135135

136136
.. zephyr-app-commands::
137137
:tool: west
138-
:app: samples/hello_world
138+
:zephyr-app: samples/hello_world
139139
:board: odroid_go
140140
:goals: build
141141
:west-args: --sysbuild

‎boards/heltec/heltec_wifi_lora32_v2/doc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ To build the sample application using sysbuild use the command:
8282

8383
.. zephyr-app-commands::
8484
:tool: west
85-
:app: samples/hello_world
85+
:zephyr-app: samples/hello_world
8686
:board: heltec_wifi_lora32_v2
8787
:goals: build
8888
:west-args: --sysbuild

‎boards/heltec/heltec_wireless_stick_lite_v3/doc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ To build the sample application using sysbuild use the command:
196196

197197
.. zephyr-app-commands::
198198
:tool: west
199-
:app: samples/hello_world
199+
:zephyr-app: samples/hello_world
200200
:board: heltec_wireless_stick_lite_v3
201201
:goals: build
202202
:west-args: --sysbuild

‎boards/lilygo/ttgo_lora32/doc/index.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ To build the sample application using sysbuild use the command:
125125

126126
.. zephyr-app-commands::
127127
:tool: west
128-
:app: samples/hello_world
128+
:zephyr-app: samples/hello_world
129129
:board: ttgo_lora32/esp32/procpu
130130
:goals: build
131131
:west-args: --sysbuild
@@ -214,7 +214,7 @@ To build the LoRa transmit sample application using sysbuild use the command:
214214

215215
.. zephyr-app-commands::
216216
:tool: west
217-
:app: samples/drivers/lora/send
217+
:zephyr-app: samples/drivers/lora/send
218218
:board: ttgo_lora32/esp32/procpu
219219
:goals: build
220220
:west-args: --sysbuild
@@ -224,7 +224,7 @@ To build the LoRa receive sample application using sysbuild use the command:
224224

225225
.. zephyr-app-commands::
226226
:tool: west
227-
:app: samples/drivers/lora/receive
227+
:zephyr-app: samples/drivers/lora/receive
228228
:board: ttgo_lora32/esp32/procpu
229229
:goals: build
230230
:west-args: --sysbuild

‎boards/lilygo/ttgo_t8c3/doc/index.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ To build the sample application using sysbuild use the command:
123123

124124
.. zephyr-app-commands::
125125
:tool: west
126-
:app: samples/hello_world
126+
:zephyr-app: samples/hello_world
127127
:board: ttgo_t8c3
128128
:goals: build
129129
:west-args: --sysbuild
@@ -212,15 +212,15 @@ To build the blinky sample:
212212

213213
.. zephyr-app-commands::
214214
:tool: west
215-
:app: samples/basic/blinky
215+
:zephyr-app: samples/basic/blinky
216216
:board: ttgo_t8c3
217217
:goals: build
218218

219219
To build the bluetooth beacon sample:
220220

221221
.. zephyr-app-commands::
222222
:tool: west
223-
:app: samples/bluetooth/beacon
223+
:zephyr-app: samples/bluetooth/beacon
224224
:board: ttgo_t8c3
225225
:goals: build
226226

‎boards/luatos/esp32c3_luatos_core/doc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ To build the sample application using sysbuild use the command:
149149

150150
.. zephyr-app-commands::
151151
:tool: west
152-
:app: samples/hello_world
152+
:zephyr-app: samples/hello_world
153153
:board: esp32c3_luatos_core
154154
:goals: build
155155
:west-args: --sysbuild

‎boards/luatos/esp32s3_luatos_core/doc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ To build the sample application using sysbuild use the command:
175175

176176
.. zephyr-app-commands::
177177
:tool: west
178-
:app: samples/hello_world
178+
:zephyr-app: samples/hello_world
179179
:board: esp32s3_luatos_core
180180
:goals: build
181181
:west-args: --sysbuild

‎boards/m5stack/m5stickc_plus/doc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ To build the sample application using sysbuild use the command:
124124

125125
.. zephyr-app-commands::
126126
:tool: west
127-
:app: samples/hello_world
127+
:zephyr-app: samples/hello_world
128128
:board: m5stickc_plus
129129
:goals: build
130130
:west-args: --sysbuild

‎boards/m5stack/stamp_c3/doc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ To build the sample application using sysbuild use the command:
9393

9494
.. zephyr-app-commands::
9595
:tool: west
96-
:app: samples/hello_world
96+
:zephyr-app: samples/hello_world
9797
:board: stamp_c3
9898
:goals: build
9999
:west-args: --sysbuild

‎boards/olimex/olimex_esp32_evb/doc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ To build the sample application using sysbuild use the command:
151151

152152
.. zephyr-app-commands::
153153
:tool: west
154-
:app: samples/hello_world
154+
:zephyr-app: samples/hello_world
155155
:board: olimex_esp32_evb
156156
:goals: build
157157
:west-args: --sysbuild

‎boards/others/icev_wireless/doc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ To build the sample application using sysbuild use the command:
138138

139139
.. zephyr-app-commands::
140140
:tool: west
141-
:app: samples/hello_world
141+
:zephyr-app: samples/hello_world
142142
:board: icev_wireless
143143
:goals: build
144144
:west-args: --sysbuild

‎boards/seeed/xiao_esp32c3/doc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ To build the sample application using sysbuild use the command:
120120

121121
.. zephyr-app-commands::
122122
:tool: west
123-
:app: samples/hello_world
123+
:zephyr-app: samples/hello_world
124124
:board: xiao_esp32c3
125125
:goals: build
126126
:west-args: --sysbuild

‎boards/seeed/xiao_esp32s3/doc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ To build the sample application using sysbuild use the command:
135135

136136
.. zephyr-app-commands::
137137
:tool: west
138-
:app: samples/hello_world
138+
:zephyr-app: samples/hello_world
139139
:board: xiao_esp32s3
140140
:goals: build
141141
:west-args: --sysbuild

‎boards/vcc-gnd/yd_esp32/doc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ To build the sample application using sysbuild use the command:
156156

157157
.. zephyr-app-commands::
158158
:tool: west
159-
:app: samples/hello_world
159+
:zephyr-app: samples/hello_world
160160
:board: yd_esp32
161161
:goals: build
162162
:west-args: --sysbuild

‎doc/build/sysbuild/index.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ As mentioned above, you can run sysbuild via ``west build`` or ``cmake``.
9595

9696
.. zephyr-app-commands::
9797
:tool: west
98-
:app: samples/hello_world
98+
:zephyr-app: samples/hello_world
9999
:board: reel_board
100100
:goals: build
101101
:west-args: --sysbuild
@@ -166,7 +166,7 @@ applying to both images debug optimizations:
166166

167167
.. zephyr-app-commands::
168168
:tool: west
169-
:app: samples/hello_world
169+
:zephyr-app: samples/hello_world
170170
:board: reel_board
171171
:goals: build
172172
:west-args: --sysbuild
@@ -316,7 +316,7 @@ enable MCUboot and build and flash the sample as follows:
316316

317317
.. zephyr-app-commands::
318318
:tool: west
319-
:app: samples/hello_world
319+
:zephyr-app: samples/hello_world
320320
:board: reel_board
321321
:goals: build
322322
:west-args: --sysbuild
@@ -381,7 +381,7 @@ specify this file when building with sysbuild, as follows:
381381

382382
.. zephyr-app-commands::
383383
:tool: west
384-
:app: samples/hello_world
384+
:zephyr-app: samples/hello_world
385385
:board: reel_board
386386
:goals: build
387387
:west-args: --sysbuild

‎doc/develop/application/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -802,7 +802,7 @@ As an example, let's build the Hello World sample for the ``reel_board``:
802802

803803
.. zephyr-app-commands::
804804
:tool: all
805-
:app: samples/hello_world
805+
:zephyr-app: samples/hello_world
806806
:board: reel_board
807807
:goals: build
808808

@@ -820,7 +820,7 @@ Using CMake directly:
820820

821821
.. zephyr-app-commands::
822822
:tool: cmake
823-
:app: samples/hello_world
823+
:zephyr-app: samples/hello_world
824824
:generator: make
825825
:host-os: unix
826826
:board: reel_board

‎doc/develop/beyond-GSG.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ a list of supported boards.
203203
#. Build the blinky sample for the ``reel_board``:
204204

205205
.. zephyr-app-commands::
206-
:app: samples/basic/blinky
206+
:zephyr-app: samples/basic/blinky
207207
:board: reel_board
208208
:goals: build
209209

‎doc/develop/debug/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@ Generate and Import an Eclipse Project
225225

226226
.. zephyr-app-commands::
227227
:tool: all
228-
:app: %ZEPHYR_BASE%\samples\synchronization
228+
:zephyr-app: samples\synchronization
229229
:host-os: win
230230
:board: frdm_k64f
231231
:gen-args: -G"Eclipse CDT4 - Ninja"

0 commit comments

Comments
 (0)