Skip to content

Commit 9a45c30

Browse files
mguetschowmguetschow
committed
examples: shorten subfolders' names
1 parent 8bbeba1 commit 9a45c30

File tree

351 files changed

+271
-271
lines changed

Some content is hidden

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

351 files changed

+271
-271
lines changed

‎.murdock

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# uncomment and change this to limit builds, e.g.,
44
#export BOARDS="samr21-xpro native"
55
# and / or
6-
#export APPS="examples/essentials/hello-world tests/unittests"
6+
#export APPS="examples/basic/hello-world tests/unittests"
77

88
QUICKBUILD_BOARDS="
99
adafruit-itsybitsy-m4
@@ -43,7 +43,7 @@ esac
4343
# on LLVM.
4444
: ${TEST_BOARDS_LLVM_COMPILE:="iotlab-m3 native native64 nrf52dk mulle nucleo-f401re samr21-xpro slstk3402a"}
4545

46-
: ${TEST_WITH_CONFIG_SUPPORTED:="examples/advanced_examples/suit_update tests/drivers/at86rf2xx_aes"}
46+
: ${TEST_WITH_CONFIG_SUPPORTED:="examples/advanced/suit_update tests/drivers/at86rf2xx_aes"}
4747

4848
export RIOT_CI_BUILD=1
4949
export CC_NOCOLOR=1

‎Makefile

+1-1
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ define welcome_message
6969
@echo " doc doc-{man,latex}"
7070
@echo ""
7171
@echo "==> tl;dr Try running:"
72-
@echo " cd examples/essentials/default"
72+
@echo " cd examples/basic/default"
7373
@echo " make BOARD=<INSERT_BOARD_NAME>"
7474
endef
7575

‎boards/adafruit-clue/doc.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The board is flashed using the `adafruit-nrfutil` Python package:
2626

2727
Example with `hello-world` application:
2828
```
29-
make BOARD=adafruit-clue -C examples/essentials/hello-world flash
29+
make BOARD=adafruit-clue -C examples/basic/hello-world flash
3030
```
3131

3232
### Accessing STDIO via UART
@@ -36,7 +36,7 @@ generally mapped to `/dev/ttyACM0`.
3636

3737
Use the `term` target to connect to the board serial port<br/>
3838
```
39-
make BOARD=adafruit-clue -C examples/essentials/hello-world term
39+
make BOARD=adafruit-clue -C examples/basic/hello-world term
4040
```
4141

4242
The `TERM_DELAY` environment variable can be used to add a delay (in second)

‎boards/adafruit-pybadge/doc.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Connect the board via USB and use `BOARD=adafruit-pybadge` with the `make` comma
2626
this uses the Arduino style bootloader preprogrammed on the board.<br/>
2727
Example with `hello-world` application:
2828
```
29-
make BOARD=adafruit-pybadge -C examples/essentials/hello-world flash
29+
make BOARD=adafruit-pybadge -C examples/basic/hello-world flash
3030
```
3131

3232
In case of a crash of the firmware, one has to manually reset the board in

‎boards/alientek-pandora/doc.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Additional resources may be found on [RT-Thread bsp support page](https://gitee.
1818
To flash the board, use the on board ST-Link programmer/debugger.
1919
Input the following command:
2020

21-
make BOARD=alientek-pandora -C examples/essentials/hello-world flash
21+
make BOARD=alientek-pandora -C examples/basic/hello-world flash
2222

2323
The NRST pin is connected to the on board debugger, so users do not need to reset manually
2424
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
3333

3434
Use the `term` target to open a terminal:
3535

36-
make BOARD=alientek-pandora -C examples/essentials/hello-world term
36+
make BOARD=alientek-pandora -C examples/basic/hello-world term
3737

3838
An on-board ST-Link compatible debugger is used to transport serial STDIO message.
3939

‎boards/arduino-mkrfox1200/doc.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ powered by an Atmel SAMD21 microcontroller.
1919
Use `BOARD=arduino-mkrfox1200` with the `make` command.<br/>
2020
Example with `hello-world` application:
2121
```
22-
make BOARD=arduino-mkrfox1200 -C examples/essentials/hello-world flash
22+
make BOARD=arduino-mkrfox1200 -C examples/basic/hello-world flash
2323
```
2424

2525
@note If the application crashes, automatic reflashing via USB, as explained

‎boards/arduino-mkrwan1300/doc.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ powered by an Atmel SAMD21 microcontroller.
1919
Use `BOARD=arduino-mkrwan1300` with the `make` command.<br/>
2020
Example with `hello-world` application:
2121
```
22-
make BOARD=arduino-mkrwan1300 -C examples/essentials/hello-world flash
22+
make BOARD=arduino-mkrwan1300 -C examples/basic/hello-world flash
2323
```
2424

2525
@note If the application crashes, automatic reflashing via USB, as explained

‎boards/arduino-nano-33-ble-sense/doc.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ This board provides 802.15.4 and BLE connectivity.
1919
Use `BOARD=arduino-nano-33-ble-sense` with the `make` command.<br/>
2020
Example with `hello-world` application:
2121
```
22-
make BOARD=arduino-nano-33-ble-sense -C examples/essentials/hello-world flash
22+
make BOARD=arduino-nano-33-ble-sense -C examples/basic/hello-world flash
2323
```
2424

2525
### Accessing STDIO via UART
@@ -29,7 +29,7 @@ generally mapped to `/dev/ttyACM0`.
2929

3030
Use the `term` target to connect to the board serial port<br/>
3131
```
32-
make BOARD=arduino-nano-33-ble-sense -C examples/essentials/hello-world term
32+
make BOARD=arduino-nano-33-ble-sense -C examples/basic/hello-world term
3333
```
3434
*/
3535

‎boards/arduino-nano-33-ble/doc.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ This board provides 802.15.4 and BLE connectivity.
1919
Use `BOARD=arduino-nano-33-ble` with the `make` command.<br/>
2020
Example with `hello-world` application:
2121
```
22-
make BOARD=arduino-nano-33-ble -C examples/essentials/hello-world flash
22+
make BOARD=arduino-nano-33-ble -C examples/basic/hello-world flash
2323
```
2424

2525
### Accessing STDIO via UART
@@ -29,6 +29,6 @@ generally mapped to `/dev/ttyACM0`.
2929

3030
Use the `term` target to connect to the board serial port<br/>
3131
```
32-
make BOARD=arduino-nano-33-ble -C examples/essentials/hello-world term
32+
make BOARD=arduino-nano-33-ble -C examples/basic/hello-world term
3333
```
3434
*/

‎boards/arduino-nano-33-iot/doc.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ powered by an Atmel SAMD21 microcontroller.
1414
Use `BOARD=arduino-nano-33-iot` with the `make` command.<br/>
1515
Example with `hello-world` application:
1616
```
17-
make BOARD=arduino-nano-33-iot -C examples/essentials/hello-world flash
17+
make BOARD=arduino-nano-33-iot -C examples/basic/hello-world flash
1818
```
1919

2020
### Accessing STDIO via UART

‎boards/atmega256rfr2-xpro/doc.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ To flash the board, just call `make` from an application directory with the
2727
`flash` target:
2828

2929
```
30-
make BOARD=atmega256rfr2-xpro -C examples/essentials/hello-world flash
30+
make BOARD=atmega256rfr2-xpro -C examples/basic/hello-world flash
3131
```
3232

3333
### Accessing STDIO via UART
@@ -36,7 +36,7 @@ STDIO can be accessed through the USB connector. The on-board UART-USB
3636
adapter is not affected by flashing. It shows up as /dev/ttyACM0 on Linux.
3737
It will be used automatically with `make term`:
3838
```
39-
make BOARD=atmega256rfr2-xpro -C examples/essentials/hello-world term
39+
make BOARD=atmega256rfr2-xpro -C examples/basic/hello-world term
4040
```
4141

4242
*/

‎boards/common/nrf52/doc.txt

+3-3
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ uses PyOCD by default.
1111
To flash the board, use `BOARD=<nrf52 board>` with the `make` command.<br/>
1212
Example with `hello-world` application:
1313
```
14-
make BOARD=<nrf52 board> -C examples/essentials/hello-world flash
14+
make BOARD=<nrf52 board> -C examples/basic/hello-world flash
1515
```
1616

1717
OpenOCD can also be used to flash nrf52 boards (except thingy52 and ruuvitag
@@ -22,13 +22,13 @@ can be used.
2222

2323
To flash the board with OpenOCD, use the `PROGRAMMER` variable:
2424
```
25-
PROGRAMMER=openocd make BOARD=<nrf52 board> -C examples/essentials/hello-world flash
25+
PROGRAMMER=openocd make BOARD=<nrf52 board> -C examples/basic/hello-world flash
2626
```
2727

2828
It is also possible to use the SWD interface of a ST-LINK/V2 in-circuit
2929
debugger/programmer with OpenOCD to flash a nrf52 board:
3030
```
31-
PROGRAMMER=openocd OPENOCD_DEBUG_ADAPTER=stlink make BOARD=<nrf52 board> -C examples/essentials/hello-world flash
31+
PROGRAMMER=openocd OPENOCD_DEBUG_ADAPTER=stlink make BOARD=<nrf52 board> -C examples/basic/hello-world flash
3232
```
3333

3434
*/

‎boards/common/particle-mesh/doc.txt

+3-3
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ To flash the board, use `BOARD=<board name>` (with board name in {particle-argon
2323
particle-boron, particle-xenon}) with the `make` command.<br/>
2424
Example with `hello-world` application:
2525
```
26-
make BOARD=particle-xenon -C examples/essentials/hello-world flash
26+
make BOARD=particle-xenon -C examples/basic/hello-world flash
2727
```
2828

2929
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.
3232

3333
To flash the board with OpenOCD, use the `PROGRAMMER` variable:
3434
```
35-
PROGRAMMER=openocd make BOARD=<board name> -C examples/essentials/hello-world flash
35+
PROGRAMMER=openocd make BOARD=<board name> -C examples/basic/hello-world flash
3636
```
3737

3838
#### 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
7272
The on-board reset button doesn't work, so to trigger a reset of the board, use
7373
the `reset` target with `make`:
7474
```
75-
make BOARD=<board name> -C examples/essentials/hello-world reset
75+
make BOARD=<board name> -C examples/basic/hello-world reset
7676
```
7777

7878
### STDIO configuration

‎boards/dwm1001/doc.txt

+3-3
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,13 @@ To program this board, plug it to your computer via USB and run the following
1919
command:
2020

2121
```
22-
make BOARD=dwm1001 -C examples/essentials/hello-world flash
22+
make BOARD=dwm1001 -C examples/basic/hello-world flash
2323
```
2424

2525
To program the board with OpenOCD, use:
2626

2727
```
28-
PROGRAMMER=openocd make BOARD=dwm1001 -C examples/essentials/hello-world flash
28+
PROGRAMMER=openocd make BOARD=dwm1001 -C examples/basic/hello-world flash
2929
```
3030

3131
## Accessing STDIO via UART
@@ -35,6 +35,6 @@ generally mapped to `/dev/ttyACM0`.
3535

3636
Use the `term` target to connect to the board serial port<br/>
3737
```
38-
make BOARD=dwm1001 -C examples/essentials/hello-world term
38+
make BOARD=dwm1001 -C examples/basic/hello-world term
3939
```
4040
*/

‎boards/e104-bt5010a-tb/doc.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ generally mapped to `/dev/ttyUSB0`.
2525

2626
Use the `term` target to connect to the board serial port<br/>
2727
```
28-
make BOARD=e104-bt5010a-tb -C examples/essentials/hello-world term
28+
make BOARD=e104-bt5010a-tb -C examples/basic/hello-world term
2929
```
3030

3131
*/

‎boards/e104-bt5011a-tb/doc.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ generally mapped to `/dev/ttyUSB0`.
2525

2626
Use the `term` target to connect to the board serial port<br/>
2727
```
28-
make BOARD=e104-bt5011a-tb -C examples/essentials/hello-world term
28+
make BOARD=e104-bt5011a-tb -C examples/basic/hello-world term
2929
```
3030

3131
*/

‎boards/feather-m0/doc.txt

+3-3
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ printf("Bat: %dV\n", vbat);
4444
Use `BOARD=feather-m0` with the `make` command.<br/>
4545
Example with `hello-world` application:
4646
```
47-
make BOARD=feather-m0 -C examples/essentials/hello-world flash
47+
make BOARD=feather-m0 -C examples/basic/hello-world flash
4848
```
4949

5050
@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
5959
and define the required WiFi parameters, for example:
6060
```
6161
CFLAGS='-DWIFI_SSID=\"<ssid>\" -DWIFI_PASS=\"<pass>\"' \
62-
make BOARD=feather-m0-wifi -C examples/networking/gnrc_networking/gnrc_networking
62+
make BOARD=feather-m0-wifi -C examples/networking/gnrc/gnrc_networking
6363
```
6464

6565
For detailed information about the parameters, see section
@@ -73,7 +73,7 @@ variant of the board automatically for LoRa applications,
7373
use `feather-m0-lora` as board:
7474

7575
```
76-
make BOARD=feather-m0-lora -C examples/networking/gnrc_networking/gnrc_lorawan
76+
make BOARD=feather-m0-lora -C examples/networking/gnrc/gnrc_lorawan
7777
```
7878

7979
For detailed information about the parameters, see section

‎boards/feather-nrf52840-sense/doc.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Both use the same flasher, bootloader, and terminal settings.
2626

2727
Example with `hello-world` application:
2828
```
29-
make BOARD=feather-nrf52840-sense -C examples/essentials/hello-world flash term
29+
make BOARD=feather-nrf52840-sense -C examples/basic/hello-world flash term
3030
```
3131

3232
On "fresh" boards the

‎boards/feather-nrf52840/doc.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ The rest of the process is automated in the usual way with `BOARD=feather-nrf528
2424

2525
Example with `hello-world` application:
2626
```
27-
make BOARD=feather-nrf52840 -C examples/essentials/hello-world flash term
27+
make BOARD=feather-nrf52840 -C examples/basic/hello-world flash term
2828
```
2929

3030
If RIOT is already running on the board, it will automatically reset the CPU and enter

‎boards/i-nucleo-lrwan1/doc.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ index c59a1939a2..0c359e438c 100755
4848
```
4949
- Run make flash:
5050
```sh
51-
make BOARD=i-nucleo-lrwan1 -C examples/essentials/hello-world flash
51+
make BOARD=i-nucleo-lrwan1 -C examples/basic/hello-world flash
5252
```
5353
The command will fail but after that the memory will be unlocked after a
5454
power cycle. The line added above in `openocd.sh` can also be removed.

‎boards/iotlab-m3/doc.txt

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

‎boards/lsn50/doc.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ exposed with v1.0).
3030
Ensure SW1 is on `flash` position.
3131
Then use the following command:
3232

33-
make BOARD=lsn50 -C examples/essentials/hello-world flash
33+
make BOARD=lsn50 -C examples/basic/hello-world flash
3434

3535
On the v1.0 version of the board, no NRST pin is exposed so one has to press the
3636
reset button during flash and release it when OpenOCD prints `adapter speed: 240 kHz`
@@ -43,7 +43,7 @@ application.
4343
STDIO is connected to pins PA9 (TX) and PA10 (RX) so an USB to UART adapter is
4444
required. Use the `term` target to open a terminal:
4545

46-
make BOARD=lsn50 -C examples/essentials/hello-world term
46+
make BOARD=lsn50 -C examples/basic/hello-world term
4747

4848
If an external ST-Link adapter is used, RX and TX pins can be directly connected
4949
to it. In this case, STDIO is available on /dev/ttyACMx (Linux case).

‎boards/mega-xplained/doc.txt

+3-3
Original file line numberDiff line numberDiff line change
@@ -39,12 +39,12 @@ square pin on the adapter connecting with the square pin on the board.
3939

4040
If using the Buspirate:
4141
```
42-
BOARD=mega-xplained make -C examples/essentials/hello-world flash
42+
BOARD=mega-xplained make -C examples/basic/hello-world flash
4343
```
4444

4545
If using the Atmel-ICE:
4646
```
47-
BOARD=mega-xplained PROGRAMMER=atmelice make -C examples/essentials/hello-world flash
47+
BOARD=mega-xplained PROGRAMMER=atmelice make -C examples/basic/hello-world flash
4848
```
4949

5050
### Accessing STDIO via UART
@@ -53,7 +53,7 @@ STDIO can be accessed through the USB connector. The on-board UART-USB
5353
adapter is not affected by flashing. It shows up as /dev/ttyACM0 on Linux.
5454
It will be used automatically with `make term`:
5555
```
56-
BOARD=mega-xplained make -C examples/essentials/hello-world term
56+
BOARD=mega-xplained make -C examples/basic/hello-world term
5757
```
5858

5959
### Pin Change Interrupts

‎boards/microbit/doc.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ fail.
9292

9393
Use it like this:
9494

95-
$ cd examples/essentials/hello-world
95+
$ cd examples/basic/hello-world
9696
$ BOARD=microbit make clean all -j4
9797
$ EMULATE=1 BOARD=microbit make term
9898

0 commit comments

Comments
 (0)