Merge pull request #21212 from mguetschow/examples-rename-match

treewide: fix example references in docs
RIOT-OS · Feb 14, 2025 · 4de6aa1 · 4de6aa1
2 parents 8947e0c + ca5fe72
commit 4de6aa1
Show file tree

Hide file tree

Showing 129 changed files with 240 additions and 240 deletions.
diff --git a/.murdock b/.murdock
@@ -3,7 +3,7 @@
 # uncomment and change this to limit builds, e.g.,
 #export BOARDS="samr21-xpro native"
 # and / or
-#export APPS="examples/hello-world tests/unittests"
+#export APPS="examples/essentials/hello-world tests/unittests"
 
 QUICKBUILD_BOARDS="
 adafruit-itsybitsy-m4
@@ -43,7 +43,7 @@ esac
 # on LLVM.
 : ${TEST_BOARDS_LLVM_COMPILE:="iotlab-m3 native native64 nrf52dk mulle nucleo-f401re samr21-xpro slstk3402a"}
 
-: ${TEST_WITH_CONFIG_SUPPORTED:="examples/suit_update tests/drivers/at86rf2xx_aes"}
+: ${TEST_WITH_CONFIG_SUPPORTED:="examples/advanced_examples/suit_update tests/drivers/at86rf2xx_aes"}
 
 export RIOT_CI_BUILD=1
 export CC_NOCOLOR=1

diff --git a/Makefile b/Makefile
@@ -69,7 +69,7 @@ define welcome_message
 	@echo " doc doc-{man,latex}"
 	@echo ""
 	@echo "==> tl;dr Try running:"
-	@echo "    cd examples/default"
+	@echo "    cd examples/essentials/default"
 	@echo "    make BOARD=<INSERT_BOARD_NAME>"
 endef
 

diff --git a/boards/adafruit-clue/doc.txt b/boards/adafruit-clue/doc.txt
@@ -26,7 +26,7 @@ The board is flashed using the `adafruit-nrfutil` Python package:
 
 Example with `hello-world` application:
 ```
-    make BOARD=adafruit-clue -C examples/hello-world flash
+    make BOARD=adafruit-clue -C examples/essentials/hello-world flash
 ```
 
 ### Accessing STDIO via UART
@@ -36,7 +36,7 @@ generally mapped to `/dev/ttyACM0`.
 
 Use the `term` target to connect to the board serial port<br/>
 ```
-    make BOARD=adafruit-clue -C examples/hello-world term
+    make BOARD=adafruit-clue -C examples/essentials/hello-world term
 ```
 
 The `TERM_DELAY` environment variable can be used to add a delay (in second)

diff --git a/boards/adafruit-pybadge/doc.txt b/boards/adafruit-pybadge/doc.txt
@@ -26,7 +26,7 @@ Connect the board via USB and use `BOARD=adafruit-pybadge` with the `make` comma
 this uses the Arduino style bootloader preprogrammed on the board.<br/>
 Example with `hello-world` application:
 ```
-     make BOARD=adafruit-pybadge -C examples/hello-world flash
+     make BOARD=adafruit-pybadge -C examples/essentials/hello-world flash
 ```
 
 In case of a crash of the firmware, one has to manually reset the board in

diff --git a/boards/alientek-pandora/doc.txt b/boards/alientek-pandora/doc.txt
@@ -18,7 +18,7 @@ Additional resources may be found on [RT-Thread bsp support page](https://gitee.
 To flash the board, use the on board ST-Link programmer/debugger.
 Input the following command:
 
-    make BOARD=alientek-pandora -C examples/hello-world flash
+    make BOARD=alientek-pandora -C examples/essentials/hello-world flash
 
 The NRST pin is connected to the on board debugger, so users do not need to reset manually
 every time it requires to flash.
@@ -33,7 +33,7 @@ Before you begin, check that the both the jumper caps marked as 'USART1' is conn
 
 Use the `term` target to open a terminal:
 
-    make BOARD=alientek-pandora -C examples/hello-world term
+    make BOARD=alientek-pandora -C examples/essentials/hello-world term
 
 An on-board ST-Link compatible debugger is used to transport serial STDIO message.
 

diff --git a/boards/arduino-mkrfox1200/doc.txt b/boards/arduino-mkrfox1200/doc.txt
@@ -19,7 +19,7 @@ powered by an Atmel SAMD21 microcontroller.
 Use `BOARD=arduino-mkrfox1200` with the `make` command.<br/>
 Example with `hello-world` application:
 ```
-     make BOARD=arduino-mkrfox1200 -C examples/hello-world flash
+     make BOARD=arduino-mkrfox1200 -C examples/essentials/hello-world flash
 ```
 
 @note     If the application crashes, automatic reflashing via USB, as explained

diff --git a/boards/arduino-mkrwan1300/doc.txt b/boards/arduino-mkrwan1300/doc.txt
@@ -19,7 +19,7 @@ powered by an Atmel SAMD21 microcontroller.
 Use `BOARD=arduino-mkrwan1300` with the `make` command.<br/>
 Example with `hello-world` application:
 ```
-     make BOARD=arduino-mkrwan1300 -C examples/hello-world flash
+     make BOARD=arduino-mkrwan1300 -C examples/essentials/hello-world flash
 ```
 
 @note     If the application crashes, automatic reflashing via USB, as explained

diff --git a/boards/arduino-nano-33-ble-sense/doc.txt b/boards/arduino-nano-33-ble-sense/doc.txt
@@ -19,7 +19,7 @@ This board provides 802.15.4 and BLE connectivity.
 Use `BOARD=arduino-nano-33-ble-sense` with the `make` command.<br/>
 Example with `hello-world` application:
 ```
-    make BOARD=arduino-nano-33-ble-sense -C examples/hello-world flash
+    make BOARD=arduino-nano-33-ble-sense -C examples/essentials/hello-world flash
 ```
 
 ### Accessing STDIO via UART
@@ -29,7 +29,7 @@ generally mapped to `/dev/ttyACM0`.
 
 Use the `term` target to connect to the board serial port<br/>
 ```
-    make BOARD=arduino-nano-33-ble-sense -C examples/hello-world term
+    make BOARD=arduino-nano-33-ble-sense -C examples/essentials/hello-world term
 ```
  */
 

diff --git a/boards/arduino-nano-33-ble/doc.txt b/boards/arduino-nano-33-ble/doc.txt
@@ -19,7 +19,7 @@ This board provides 802.15.4 and BLE connectivity.
 Use `BOARD=arduino-nano-33-ble` with the `make` command.<br/>
 Example with `hello-world` application:
 ```
-    make BOARD=arduino-nano-33-ble -C examples/hello-world flash
+    make BOARD=arduino-nano-33-ble -C examples/essentials/hello-world flash
 ```
 
 ### Accessing STDIO via UART
@@ -29,6 +29,6 @@ generally mapped to `/dev/ttyACM0`.
 
 Use the `term` target to connect to the board serial port<br/>
 ```
-    make BOARD=arduino-nano-33-ble -C examples/hello-world term
+    make BOARD=arduino-nano-33-ble -C examples/essentials/hello-world term
 ```
  */
diff --git a/boards/arduino-nano-33-iot/doc.txt b/boards/arduino-nano-33-iot/doc.txt
@@ -14,7 +14,7 @@ powered by an Atmel SAMD21 microcontroller.
 Use `BOARD=arduino-nano-33-iot` with the `make` command.<br/>
 Example with `hello-world` application:
 ```
-     make BOARD=arduino-nano-33-iot -C examples/hello-world flash
+     make BOARD=arduino-nano-33-iot -C examples/essentials/hello-world flash
 ```
 
 ### Accessing STDIO via UART

diff --git a/boards/atmega256rfr2-xpro/doc.txt b/boards/atmega256rfr2-xpro/doc.txt
@@ -27,7 +27,7 @@ To flash the board, just call `make` from an application directory with the
 `flash` target:
 
 ```
-make BOARD=atmega256rfr2-xpro -C examples/hello-world flash
+make BOARD=atmega256rfr2-xpro -C examples/essentials/hello-world flash
 ```
 
 ### Accessing STDIO via UART
@@ -36,7 +36,7 @@ STDIO can be accessed through the USB connector. The on-board UART-USB
 adapter is not affected by flashing. It shows up as /dev/ttyACM0 on Linux.
 It will be used automatically with `make term`:
 ```
-make BOARD=atmega256rfr2-xpro -C examples/hello-world term
+make BOARD=atmega256rfr2-xpro -C examples/essentials/hello-world term
 ```
 
 */
diff --git a/boards/common/nrf52/doc.txt b/boards/common/nrf52/doc.txt
@@ -11,7 +11,7 @@ uses PyOCD by default.
 To flash the board, use `BOARD=<nrf52 board>` with the `make` command.<br/>
 Example with `hello-world` application:
 ```
-    make BOARD=<nrf52 board> -C examples/hello-world flash
+    make BOARD=<nrf52 board> -C examples/essentials/hello-world flash
 ```
 
 OpenOCD can also be used to flash nrf52 boards (except thingy52 and ruuvitag
@@ -22,13 +22,13 @@ can be used.
 
 To flash the board with OpenOCD, use the `PROGRAMMER` variable:
 ```
-    PROGRAMMER=openocd make BOARD=<nrf52 board> -C examples/hello-world flash
+    PROGRAMMER=openocd make BOARD=<nrf52 board> -C examples/essentials/hello-world flash
 ```
 
 It is also possible to use the SWD interface of a ST-LINK/V2 in-circuit
 debugger/programmer with OpenOCD to flash a nrf52 board:
 ```
-    PROGRAMMER=openocd OPENOCD_DEBUG_ADAPTER=stlink make BOARD=<nrf52 board> -C examples/hello-world flash
+    PROGRAMMER=openocd OPENOCD_DEBUG_ADAPTER=stlink make BOARD=<nrf52 board> -C examples/essentials/hello-world flash
 ```
 
 */
diff --git a/boards/common/particle-mesh/doc.txt b/boards/common/particle-mesh/doc.txt
@@ -23,7 +23,7 @@ To flash the board, use `BOARD=<board name>` (with board name in {particle-argon
 particle-boron, particle-xenon}) with the `make` command.<br/>
 Example with `hello-world` application:
 ```
-    make BOARD=particle-xenon -C examples/hello-world flash
+    make BOARD=particle-xenon -C examples/essentials/hello-world flash
 ```
 
 In this case, OpenOCD can also be used. For the moment, the latest stable
@@ -32,7 +32,7 @@ built against the actual development version can be used.
 
 To flash the board with OpenOCD, use the `PROGRAMMER` variable:
 ```
-    PROGRAMMER=openocd make BOARD=<board name> -C examples/hello-world flash
+    PROGRAMMER=openocd make BOARD=<board name> -C examples/essentials/hello-world flash
 ```
 
 #### Alternative flashing procedure: Particle bootloader and DFU-Util
@@ -72,7 +72,7 @@ Then, the checksum is only calculated over the memory region that contains the i
 The on-board reset button doesn't work, so to trigger a reset of the board, use
 the `reset` target with `make`:
 ```
-    make BOARD=<board name> -C examples/hello-world reset
+    make BOARD=<board name> -C examples/essentials/hello-world reset
 ```
 
 ### STDIO configuration

diff --git a/boards/dwm1001/doc.txt b/boards/dwm1001/doc.txt
@@ -19,13 +19,13 @@ To program this board, plug it to your computer via USB and run the following
 command:
 
 ```
-make BOARD=dwm1001 -C examples/hello-world flash
+make BOARD=dwm1001 -C examples/essentials/hello-world flash
 ```
 
 To program the board with OpenOCD, use:
 
 ```
-PROGRAMMER=openocd make BOARD=dwm1001 -C examples/hello-world flash
+PROGRAMMER=openocd make BOARD=dwm1001 -C examples/essentials/hello-world flash
 ```
 
 ## Accessing STDIO via UART
@@ -35,6 +35,6 @@ generally mapped to `/dev/ttyACM0`.
 
 Use the `term` target to connect to the board serial port<br/>
 ```
-make BOARD=dwm1001 -C examples/hello-world term
+make BOARD=dwm1001 -C examples/essentials/hello-world term
 ```
  */
diff --git a/boards/e104-bt5010a-tb/doc.txt b/boards/e104-bt5010a-tb/doc.txt
@@ -25,7 +25,7 @@ generally mapped to `/dev/ttyUSB0`.
 
 Use the `term` target to connect to the board serial port<br/>
 ```
-    make BOARD=e104-bt5010a-tb -C examples/hello-world term
+    make BOARD=e104-bt5010a-tb -C examples/essentials/hello-world term
 ```
 
  */
diff --git a/boards/e104-bt5011a-tb/doc.txt b/boards/e104-bt5011a-tb/doc.txt
@@ -25,7 +25,7 @@ generally mapped to `/dev/ttyUSB0`.
 
 Use the `term` target to connect to the board serial port<br/>
 ```
-    make BOARD=e104-bt5011a-tb -C examples/hello-world term
+    make BOARD=e104-bt5011a-tb -C examples/essentials/hello-world term
 ```
 
  */
diff --git a/boards/feather-m0/doc.txt b/boards/feather-m0/doc.txt
@@ -44,7 +44,7 @@ printf("Bat: %dV\n", vbat);
 Use `BOARD=feather-m0` with the `make` command.<br/>
 Example with `hello-world` application:
 ```
-     make BOARD=feather-m0 -C examples/hello-world flash
+     make BOARD=feather-m0 -C examples/essentials/hello-world flash
 ```
 
 @note     If the application crashes, automatic reflashing via USB, as explained
@@ -59,7 +59,7 @@ automatically for networking applications, use `feather-m0-wifi` as board
 and define the required WiFi parameters, for example:
 ```
      CFLAGS='-DWIFI_SSID=\"<ssid>\" -DWIFI_PASS=\"<pass>\"' \
-     make BOARD=feather-m0-wifi -C examples/gnrc_networking
+     make BOARD=feather-m0-wifi -C examples/networking/gnrc_networking/gnrc_networking
 ```
 
 For detailed information about the parameters, see section
@@ -73,7 +73,7 @@ variant of the board automatically for LoRa applications,
 use `feather-m0-lora` as board:
 
 ```
-make BOARD=feather-m0-lora -C examples/gnrc_lorawan
+make BOARD=feather-m0-lora -C examples/networking/gnrc_networking/gnrc_lorawan
 ```
 
 For detailed information about the parameters, see section

diff --git a/boards/feather-nrf52840-sense/doc.txt b/boards/feather-nrf52840-sense/doc.txt
@@ -26,7 +26,7 @@ Both use the same flasher, bootloader, and terminal settings.
 
 Example with `hello-world` application:
 ```
-     make BOARD=feather-nrf52840-sense -C examples/hello-world flash term
+     make BOARD=feather-nrf52840-sense -C examples/essentials/hello-world flash term
 ```
 
 On "fresh" boards the

diff --git a/boards/feather-nrf52840/doc.txt b/boards/feather-nrf52840/doc.txt
@@ -24,7 +24,7 @@ The rest of the process is automated in the usual way with `BOARD=feather-nrf528
 
 Example with `hello-world` application:
 ```
-     make BOARD=feather-nrf52840 -C examples/hello-world flash term
+     make BOARD=feather-nrf52840 -C examples/essentials/hello-world flash term
 ```
 
 If RIOT is already running on the board, it will automatically reset the CPU and enter

diff --git a/boards/i-nucleo-lrwan1/doc.txt b/boards/i-nucleo-lrwan1/doc.txt
@@ -48,7 +48,7 @@ index c59a1939a2..0c359e438c 100755
 ```
 - Run make flash:
 ```sh
-make BOARD=i-nucleo-lrwan1 -C examples/hello-world flash
+make BOARD=i-nucleo-lrwan1 -C examples/essentials/hello-world flash
 ```
   The command will fail but after that the memory will be unlocked after a
   power cycle. The line added above in `openocd.sh` can also be removed.

diff --git a/boards/iotlab-m3/doc.txt b/boards/iotlab-m3/doc.txt
@@ -102,13 +102,13 @@ debug` - assuming that the current directory is your application directory. It
 establishes an openocd connection to the device and starts gdb connected to the
 openocd instance. For example, it should look something like this
 ```
-[user@host RIOT]$ cd examples/default/
+[user@host RIOT]$ cd examples/essentials/default/
 [user@host default]$ BOARD=iotlab-m3 make
 Building application default for iotlab-m3 w/ MCU stm32f1.
 ...
 [user@hostdefault]$ BOARD=iotlab-m3 make debug
 RIOT/boards/hikob-common/dist/debug.sh RIOT/boards/iotlab-m3/dist/gdb.conf
-RIOT/examples/default/bin/iotlab-m3/default.elf
+RIOT/examples/essentials/default/bin/iotlab-m3/default.elf
 Open On-Chip Debugger 0.8.0 (2014-07-27-20:18)
 Licensed under GNU GPL v2
 For bug reports, read
@@ -123,7 +123,7 @@ This GDB was configured as "--host=x86_64-apple-darwin10 --target=arm-none-
 eabi".
 For bug reporting instructions, please see:
 <http://www.gnu.org/software/gdb/bugs/>...
-Reading symbols from RIOT/examples/default/bin/iotlab-m3/default.elf...done.
+Reading symbols from RIOT/examples/essentials/default/bin/iotlab-m3/default.elf...done.
 idle_thread (arg=<optimized out>) at RIOT/core/kernel_init.c:67
 67               lpm_set(LPM_IDLE);
 JTAG tap: stm32f1x.cpu tap/device found: 0x3ba00477 (mfg: 0x23b, part:

diff --git a/boards/lsn50/doc.txt b/boards/lsn50/doc.txt
@@ -30,7 +30,7 @@ exposed with v1.0).
 Ensure SW1 is on `flash` position.
 Then use the following command:
 
-    make BOARD=lsn50 -C examples/hello-world flash
+    make BOARD=lsn50 -C examples/essentials/hello-world flash
 
 On the v1.0 version of the board, no NRST pin is exposed so one has to press the
 reset button during flash and release it when OpenOCD prints `adapter speed: 240 kHz`
@@ -43,7 +43,7 @@ application.
 STDIO is connected to pins PA9 (TX) and PA10 (RX) so an USB to UART adapter is
 required. Use the `term` target to open a terminal:
 
-    make BOARD=lsn50 -C examples/hello-world term
+    make BOARD=lsn50 -C examples/essentials/hello-world term
 
 If an external ST-Link adapter is used, RX and TX pins can be directly connected
 to it. In this case, STDIO is available on /dev/ttyACMx (Linux case).

diff --git a/boards/mega-xplained/doc.txt b/boards/mega-xplained/doc.txt
@@ -39,12 +39,12 @@ square pin on the adapter connecting with the square pin on the board.
 
    If using the Buspirate:
 ```
-     BOARD=mega-xplained make -C examples/hello-world flash
+     BOARD=mega-xplained make -C examples/essentials/hello-world flash
 ```
 
    If using the Atmel-ICE:
 ```
-     BOARD=mega-xplained PROGRAMMER=atmelice make -C examples/hello-world flash
+     BOARD=mega-xplained PROGRAMMER=atmelice make -C examples/essentials/hello-world flash
 ```
 
 ### Accessing STDIO via UART
@@ -53,7 +53,7 @@ STDIO can be accessed through the USB connector. The on-board UART-USB
 adapter is not affected by flashing. It shows up as /dev/ttyACM0 on Linux.
 It will be used automatically with `make term`:
 ```
-     BOARD=mega-xplained make -C examples/hello-world term
+     BOARD=mega-xplained make -C examples/essentials/hello-world term
 ```
 
 ### Pin Change Interrupts

diff --git a/boards/microbit/doc.txt b/boards/microbit/doc.txt
@@ -92,7 +92,7 @@ fail.
 
 Use it like this:
 
-    $ cd examples/hello-world
+    $ cd examples/essentials/hello-world
     $ BOARD=microbit make clean all -j4
     $ EMULATE=1 BOARD=microbit make term