kaspar/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-12-26 06:53:52 +01:00
Code Releases Activity

treewide: adapt GNRC example paths in documentation

Browse Source
This commit is contained in:
Benjamin Valentin 2025-10-29 15:10:06 +01:00
parent 99a121b474
commit 88bd202031
19 changed files with 35 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
boards/feather-m0/doc.md
View File

@ -66,7 +66,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/networking/gnrc/gnrc_networking
make BOARD=feather-m0-wifi -C examples/networking/gnrc/networking
```
For detailed information about the parameters, see section
@ -80,7 +80,7 @@ variant of the board automatically for LoRa applications,
use `feather-m0-lora` as board:
```
make BOARD=feather-m0-lora -C examples/networking/gnrc/gnrc_lorawan
make BOARD=feather-m0-lora -C examples/networking/gnrc/lorawan
```
For detailed information about the parameters, see section

2
boards/openlabs-kw41z-mini/doc.md
View File

@ -57,7 +57,7 @@ running OpenOCD.
# build and flash the gnrc_networking example
cd RIOT/examples/networking/gnrc/gnrc_networking
cd RIOT/examples/networking/gnrc/networking
BOARD=openlabs-kw41z-mini CFLAGS+="-DKW41ZRF_ENABLE_LEDS=1" make -j4 flash
### Debug Uart Pinout

6
cpu/esp32/doc.md
View File

@ -1688,7 +1688,7 @@ line, for example:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
USEMODULE=esp_wifi \
CFLAGS='-DWIFI_SSID=\"MySSID\" -DWIFI_PASS=\"MyPassphrase\"' \
make -C examples/networking/gnrc/gnrc_networking BOARD=...
make -C examples/networking/gnrc/networking BOARD=...
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@note
@ -1745,7 +1745,7 @@ line, for example:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
USEMODULE=esp_wifi_enterprise \
CFLAGS='-DWIFI_SSID=\"MySSID\" -DWIFI_EAP_ID=\"anonymous\" -DWIFI_EAP_USER=\"MyUserName\" -DWIFI_EAP_PASS=\"MyPassphrase\"' \
make -C examples/networking/gnrc/gnrc_networking BOARD=...
make -C examples/networking/gnrc/networking BOARD=...
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@note
@ -1797,7 +1797,7 @@ line, for example:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
USEMODULE=esp_wifi_ap \
CFLAGS='-DWIFI_SSID=\"MySSID\" -DWIFI_PASS=\"MyPassphrase\" -DESP_WIFI_MAX_CONN=1' \
make -C examples/networking/gnrc/gnrc_networking BOARD=...
make -C examples/networking/gnrc/networking BOARD=...
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@note

4
cpu/esp8266/doc.md
View File

@ -718,7 +718,7 @@ line, e.g.:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
USEMODULE=esp_wifi \
CFLAGS='-DWIFI_SSID=\"MySSID\" -DWIFI_PASS=\"MyPassphrase\"' \
make -C examples/networking/gnrc/gnrc_networking BOARD=...
make -C examples/networking/gnrc/networking BOARD=...
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@note
@ -769,7 +769,7 @@ line, for example:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
USEMODULE=esp_wifi_ap \
CFLAGS='-DWIFI_SSID=\"MySSID\" -DWIFI_PASS=\"MyPassphrase\" -DESP_WIFI_MAX_CONN=1' \
make -C examples/networking/gnrc/gnrc_networking BOARD=...
make -C examples/networking/gnrc/networking BOARD=...
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@note

4
cpu/esp_common/esp-wifi/doc.md
View File

@ -46,7 +46,7 @@ line, for example:
```
USEMODULE=esp_wifi \
CFLAGS='-DWIFI_SSID=\"MySSID\" -DWIFI_PASS=\"MyPassphrase\"' \
make -C examples/networking/gnrc/gnrc_networking BOARD=...
make -C examples/networking/gnrc/networking BOARD=...
```
@note
@ -97,7 +97,7 @@ line, for example:
```
USEMODULE=esp_wifi_enterprise \
CFLAGS='-DWIFI_SSID=\"MySSID\" -DWIFI_EAP_ID=\"anonymous\" -DWIFI_EAP_USER=\"MyUserName\" -DWIFI_EAP_PASS=\"MyPassphrase\"' \
make -C examples/networking/gnrc/gnrc_networking BOARD=...
make -C examples/networking/gnrc/networking BOARD=...
```
@note

8
dist/tools/desvirt/README.desvirt.md vendored
View File

@ -85,16 +85,16 @@ lossnet : line4: New link from line4_2 to line4_3, rate=100mbit, loss=0.0
lossnet : line4: New link from line4_3 to line4_2, rate=100mbit, loss=0.0, delay=0.0
vnet : Network Name: line4
vm : Defining RIOT native process line4_1
riotnative : Start the RIOT: socat EXEC:'/home/pschmerzl/RIOT/examples/networking/gnrc/gnrc_networking/bin/native/gnrc_networking.elf line4_1',end-close,stderr,pty TCP-L:4711,reuseaddr,fork
riotnative : Start the RIOT: socat EXEC:'/home/pschmerzl/RIOT/examples/networking/gnrc/networking/bin/native/gnrc_networking.elf line4_1',end-close,stderr,pty TCP-L:4711,reuseaddr,fork
riotnative : PID: 18235
vm : Defining RIOT native process line4_0
riotnative : Start the RIOT: socat EXEC:'/home/pschmerzl/RIOT/examples/networking/gnrc/gnrc_networking/bin/native/gnrc_networking.elf line4_0',end-close,stderr,pty TCP-L:4712,reuseaddr,fork
riotnative : Start the RIOT: socat EXEC:'/home/pschmerzl/RIOT/examples/networking/gnrc/networking/bin/native/gnrc_networking.elf line4_0',end-close,stderr,pty TCP-L:4712,reuseaddr,fork
riotnative : PID: 18236
vm : Defining RIOT native process line4_3
riotnative : Start the RIOT: socat EXEC:'/home/pschmerzl/RIOT/examples/networking/gnrc/gnrc_networking/bin/native/gnrc_networking.elf line4_3',end-close,stderr,pty TCP-L:4713,reuseaddr,fork
riotnative : Start the RIOT: socat EXEC:'/home/pschmerzl/RIOT/examples/networking/gnrc/networking/bin/native/gnrc_networking.elf line4_3',end-close,stderr,pty TCP-L:4713,reuseaddr,fork
riotnative : PID: 18237
vm : Defining RIOT native process line4_2
riotnative : Start the RIOT: socat EXEC:'/home/pschmerzl/RIOT/examples/networking/gnrc/gnrc_networking/bin/native/gnrc_networking.elf line4_2',end-close,stderr,pty TCP-L:4714,reuseaddr,fork
riotnative : Start the RIOT: socat EXEC:'/home/pschmerzl/RIOT/examples/networking/gnrc/networking/bin/native/gnrc_networking.elf line4_2',end-close,stderr,pty TCP-L:4714,reuseaddr,fork
riotnative : PID: 18238
```

2
dist/tools/dhcpv6-pd_ia/README.md vendored
View File

@ -22,4 +22,4 @@ the script
[DHCPv6]: https://tools.ietf.org/html/rfc8415
[prefix delegation]: https://en.wikipedia.org/wiki/Prefix_delegation
[Kea]: http://kea.isc.org
[`gnrc_border_router` example]: ../../../examples/networking/gnrc/gnrc_border_router
[`gnrc_border_router` example]: ../../../examples/networking/gnrc/border_router

4
dist/tools/vagrant/freebsd/README.md vendored
View File

@ -39,8 +39,8 @@ Even applications requiring network interface access should be able to work:
```sh
sudo dist/tools/tapsetup/tapsetup
make -C examples/networking/gnrc/gnrc_networking all -j16
make -C examples/networking/gnrc/gnrc_networking term
make -C examples/networking/gnrc/networking all -j16
make -C examples/networking/gnrc/networking term
```
```

6
dist/tools/zep_dispatch/README.md vendored
View File

@ -117,7 +117,7 @@ This can be changed with the `TOPOLOGY` environment variable.
Next, start the border router example with RPL enabled:
USEMODULE=gnrc_rpl make -C examples/networking/gnrc/gnrc_border_router all term
USEMODULE=gnrc_rpl make -C examples/networking/gnrc/border_router all term
Verify that the border router got a prefix on it's downstream interface with `ifconfig`.
@ -149,8 +149,8 @@ Iface 6 HWaddr: 7A:37:FC:7D:1A:AF
Now start as many `gnrc_networking` nodes as you have mesh nodes defined in your topology file:
USE_ZEP=1 make -C examples/networking/gnrc/gnrc_networking all term
USE_ZEP=1 make -C examples/networking/gnrc/gnrc_networking all term
USE_ZEP=1 make -C examples/networking/gnrc/networking all term
USE_ZEP=1 make -C examples/networking/gnrc/networking all term
…
The node should be able to join the DODAG as you can verify with the `rpl` command:

2
doc/guides/getting-started/building_example.mdx
View File

@ -69,7 +69,7 @@ the `dist/tools/pyterm/` directory. If you choose to use another terminal
program you can set `TERMPROG` (and if need be the `TERMFLAGS`) macros:
```bash
make -C examples/networking/gnrc/gnrc_networking/ term \
make -C examples/networking/gnrc/networking/ term \
BOARD=samr21-xpro \
TERMPROG=gtkterm \
TERMFLAGS="-s 115200 -p /dev/ttyACM0 -e"

2
drivers/atwinc15x0/doc.txt
View File

@ -168,7 +168,7 @@ CFLAGS='-DWIFI_SSID=\"ssid\" -DWIFI_PASS=\"pass\" \
-DATWINC15X0_PARAM_SSN_PIN=GPIO_PIN\(1,6\) \
-DATWINC15X0_PARAM_RESET_PIN=GPIO_PIN\(1,4\) \
-DATWINC15X0_PARAM_IRQ_PIN=GPIO_PIN\(0,8\)' \
make BOARD=... -C examples/networking/gnrc/gnrc_networking flash term
make BOARD=... -C examples/networking/gnrc/networking flash term
```
*/

2
drivers/doc.txt
View File

@ -157,7 +157,7 @@
* The driver is enabled by using the module `shield_w5100`, e.g. with:
*
* ```
* USEMODULE=shield_w5100 make BOARD=arduino-due -C examples/networking/gnrc/gnrc_networking
* USEMODULE=shield_w5100 make BOARD=arduino-due -C examples/networking/gnrc/networking
* ```
*
* It depends on @ref drivers_w5100 and provides nothing more than the providing

10
examples/README.md
View File

@ -98,11 +98,11 @@ Here is a quick overview of the examples available in the RIOT:
| Example | Description |
|---------|-------------|
| [gnrc_minimal](./networking/gnrc/gnrc_minimal/README.md) | This is a minimalistic example for RIOT's gnrc network stack. |
| [gnrc_networking](./networking/gnrc/gnrc_networking/README.md) | This example demonstrates the usage of the GNRC network stack in RIOT. |
| [gnrc_networking_subnets](./networking/gnrc/gnrc_networking_subnets/README.md) | This example demonstrates IPv6 subnet auto-configuration for networks on a tree topology. |
| [gnrc_border_router](./networking/gnrc/gnrc_border_router/README.md) | Example of `gnrc_border_router` using automatic configuration |
| [gnrc_lorawan](./networking/gnrc/gnrc_lorawan/README.md) | Send and receive LoRaWAN packets and perform basic LoRaWAN commands |
| [gnrc_minimal](./networking/gnrc/minimal/README.md) | This is a minimalistic example for RIOT's gnrc network stack. |
| [gnrc_networking](./networking/gnrc/networking/README.md) | This example demonstrates the usage of the GNRC network stack in RIOT. |
| [gnrc_networking_subnets](./networking/gnrc/networking_subnets/README.md) | This example demonstrates IPv6 subnet auto-configuration for networks on a tree topology. |
| [gnrc_border_router](./networking/gnrc/border_router/README.md) | Example of `gnrc_border_router` using automatic configuration |
| [gnrc_lorawan](./networking/gnrc/lorawan/README.md) | Send and receive LoRaWAN packets and perform basic LoRaWAN commands |
### DTLS

4
examples/networking/coap/gcoap/README.md
View File

@ -93,5 +93,5 @@ implementations:
[1]: https://tools.ietf.org/html/rfc7252 "CoAP spec"
[2]: https://github.com/RIOT-OS/RIOT/tree/master/examples/networking/gnrc/gnrc_networking "instructions"
[3]: https://github.com/RIOT-OS/RIOT/tree/master/examples/networking/gnrc/gnrc_border_router "SLIP instructions"
[2]: https://github.com/RIOT-OS/RIOT/tree/master/examples/networking/gnrc/networking "instructions"
[3]: https://github.com/RIOT-OS/RIOT/tree/master/examples/networking/gnrc/border_router "SLIP instructions"

2
examples/networking/gnrc/border_router/README.md
View File

@ -123,7 +123,7 @@ This is done through the same serial interface.
By typing `help` you will get the list of available shell commands.
At this point you should be able to ping motes using their global address.
For instance, if you use the [`gnrc_networking`](https://github.com/RIOT-OS/RIOT/tree/master/examples/networking/gnrc/gnrc_networking) example on the mote, you can
For instance, if you use the [`gnrc_networking`](https://github.com/RIOT-OS/RIOT/tree/master/examples/networking/gnrc/networking) example on the mote, you can
ping it from your machine with:
```

2
pkg/nimble/README.ipv6-over-ble.md
View File

@ -25,7 +25,7 @@ following:
## Preparing the RIOT node
First, you compile and flash the `examples/networking/gnrc/gnrc_networking` application to your
First, you compile and flash the `examples/networking/gnrc/networking` application to your
RIOT device. When doing this, make sure to enable SLAAC
(`CFLAGS=-DCONFIG_GNRC_IPV6_NIB_SLAAC=1`), see note above.

2
tests/net/gnrc_sixlowpan_frag_sfr_congure_impl/README.md
View File

@ -5,4 +5,4 @@ so SFR with different CongURE implementations can be tested. When `CONGURE_IMPL`
is not set in the environment, `gnrc_sixlowpan_frag_sfr_congure_sfr` is used,
other implementations can be used with `congure_<impl>`.
[1]: https://github.com/RIOT-OS/RIOT/tree/master/examples/networking/gnrc/gnrc_networking
[1]: https://github.com/RIOT-OS/RIOT/tree/master/examples/networking/gnrc/networking

2
tests/net/gnrc_udp/README.md
View File

@ -8,4 +8,4 @@ The server is also modified as it outputs the number of currently received
packets when a new packet is received instead of the content of the new packet.
This counter can be reset using `udp reset`
[1]: https://github.com/RIOT-OS/RIOT/tree/master/examples/networking/gnrc/gnrc_networking
[1]: https://github.com/RIOT-OS/RIOT/tree/master/examples/networking/gnrc/networking

2
tests/riotboot_flashwrite/README.md
View File

@ -27,7 +27,7 @@ Then provide de device and test:
On another device setup a BR and start `start_network.sh` on that device serial
port.
$ BOARD=<board> make -C examples/networking/gnrc/gnrc_border_router flash
$ BOARD=<board> make -C examples/networking/gnrc/border_router flash
$ sudo dist/tools/ethos/start_network.sh /dev/ttyACMx riot0 2001:db8::/64