Skip to content

Commit e46e3ac

Browse files
authored
Merge pull request #21792 from LasseRosenow/doxygen-deprecate-getting-started
doc: deprecate Doxygen `Getting Started` and add CoAP guide
2 parents e4a031c + d69396e commit e46e3ac

File tree

16 files changed

+1532
-76
lines changed

16 files changed

+1532
-76
lines changed

dist/tools/code_in_guides_check/check_for_code.sh

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,13 @@ parse_code_block() {
3838

3939
# Check if this code exists in any file in the source directory
4040
found=0
41-
for src_file in "$SOURCE_DIR"/*; do
42-
# Skip if not a regular file
43-
[ -f "$src_file" ] || continue
44-
41+
# Exclude `/bin/` folders
42+
INPUT_FILES=$(
43+
find "$SOURCE_DIR" \
44+
-type d -name "bin" -prune\
45+
-or -type f -print\
46+
)
47+
for src_file in $INPUT_FILES; do
4548
# Read the file content
4649
src_content=$(cat "$src_file")
4750

doc/doxygen/src/getting-started.md

Lines changed: 8 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
1-
Getting started {#getting-started}
1+
Getting started (Deprecated) {#getting-started}
22
===============
33

4+
@deprecated Guides have moved to the [Guide Site](https://guide.riot-os.org/getting-started/installing/).
5+
This page will be removed after release 2026.04.
6+
47
[TOC]
58

69
@deprecated See [Setup Guide](https://guide.riot-os.org/getting-started/installing/#architecture-specific-requirements) on the RIOT Guide Site for the latest information. This section will be removed after release 2025.11.
@@ -17,28 +20,11 @@ Building and executing an example {#building-and-executing-an-example}
1720

1821
Configuring an application {#configuring-an-application}
1922
--------------------------
20-
Many modules in RIOT offer configuration options that will be considered during
21-
compile-time.They are modeled as macros that can be overridden by the user.
22-
Currently there are two ways of doing this: using `CFLAGS` or via
23-
@ref kconfig-in-riot "Kconfig" (the last one is currently only possible for a
24-
subset of modules).
25-
26-
For instructions on how to configure via `CFLAGS` check the
27-
@ref config "identified compile-time configurations". To learn how to use
28-
Kconfig in RIOT, please refer to the
29-
[User's guide to configure with Kconfig](https://guide.riot-os.org/build-system/kconfig/#configure-using-menuconfig).
23+
@deprecated See [Configuring an Application](https://guide.riot-os.org/advanced_tutorials/creating_application/#configuring-an-application) on the RIOT Guide Site for the latest information. This section will be removed after release 2026.04.
3024

3125
Default configurations {#default-configurations}
3226
----------------------
33-
When devices have a common access interface, having a default configuration to
34-
enable them across platforms, without having to explicitly specify which modules
35-
to include, comes in handy. For this, two pseudomodules are defined:
36-
37-
- `saul_default`: will enable all the drivers of sensors and actuators that are
38-
present in the target platform.
39-
40-
- `netdev_default`: will enable all the drivers of network devices
41-
present in the target platform.
27+
@deprecated See [Default Configurations](https://guide.riot-os.org/advanced_tutorials/creating_application/#default-configurations) on the RIOT Guide Site for the latest information. This section will be removed after release 2026.04.
4228

4329
Use Docker to build RIOT {#docker}
4430
========================
@@ -48,37 +34,9 @@ Use Docker to build RIOT {#docker}
4834
Generating compile_commands.json e.g. for code completion in IDEs
4935
=================================================================
5036

51-
See [Setup Guide](https://guide.riot-os.org/getting-started/installing/#using-vs-code-for-development) for a guide on how to set up VS Code for RIOT development using the `compile_commands.json` file.
52-
53-
This target will honor the variables controlling the build process such as `BOARD`, `TOOLCHAIN`,
54-
`DEVELHELP`, etc. just like the usual build process. This works without actual compilation. By
55-
default, the `compile_commands.json` is placed in the RIOT base directory. This behavior can be
56-
overwritten using the `COMPILE_COMMANDS_PATH` variable by specifying the full absolute path
57-
(including file name) of the `compile_commands.json` instead.
58-
59-
***Note:*** By default, the built-in include search directories of GCC will be explicitly added
60-
and flags incompatible with `clangd` will be dropped. This will allow using `clangd` as language
61-
server out of the box. If this is not desired, run `export COMPILE_COMMANDS_FLAGS=""` to turn
62-
modification of the compile commands off. For a list of available flags, run
63-
`./dist/tools/compile_commands/compile_commands.py --help` in the RIOT base directory.
37+
@deprecated See [Generating compile_commands.json](https://guide.riot-os.org/getting-started/installing/#generating-compile_commandsjson-eg-for-code-completion-in-ides) on the RIOT Guide Site for the latest information. This section will be removed after release 2026.04.
6438

6539
Using the native port with networking
6640
=====================================
6741

68-
If you compile RIOT for the native cpu and include the `netdev_tap` module,
69-
you can specify a network interface like this: `PORT=tap0 make term`
70-
71-
Setting up a tap network
72-
------------------------
73-
74-
There is a shell script in `RIOT/dist/tools/tapsetup` called `tapsetup` which
75-
you can use to create a network of tap interfaces.
76-
77-
*USAGE*
78-
79-
To create a bridge and two (or `count` at your option) tap interfaces:
80-
~~~~~~~{.sh}
81-
sudo ./dist/tools/tapsetup/tapsetup [-c [<count>]]
82-
~~~~~~~
83-
84-
A detailed example can be found in `examples/networking/gnrc/gnrc_networking`.
42+
@deprecated See [Networking](https://guide.riot-os.org/c_tutorials/networking/) on the RIOT Guide Site for the latest information. This section will be removed after release 2026.04.

doc/guides/advanced_tutorials/creating_application.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,60 @@ USEMODULE += gnrc_udp
9595

9696
Modules typically pull in all required dependencies themselves.
9797

98+
### Configuring an Application
99+
100+
Many modules in RIOT offer configuration options that will be considered during
101+
compile-time. They are modeled as macros that can be overridden by the user.
102+
Currently there are three ways of doing this: Using `CFLAGS`, `pseudomodules`
103+
and [Kconfig](https://guide.riot-os.org/build-system/kconfig) (the last one is
104+
currently only possible for a subset of modules).
105+
106+
#### CFLAGS
107+
108+
`CFLAGS` can be set in your `Makefile` to configure the values of `defines`.
109+
Make sure to not override the `CFLAGS` variable and only extend it using
110+
the `+=` operator.
111+
112+
For example, to increase the stack size of the main thread,
113+
your Makefile needs to contain this line:
114+
115+
```makefile
116+
CFLAGS += -DTHREAD_STACKSIZE_MAIN=2048
117+
```
118+
119+
For a list of all compile time configurations check the
120+
[API Documentation](https://doc.riot-os.org/group__config.html).
121+
122+
#### Kconfig
123+
124+
To learn how to use [Kconfig](https://guide.riot-os.org/build-system/kconfig)
125+
in RIOT, please refer to the
126+
[User Guide to Configure with Kconfig](https://guide.riot-os.org/build-system/kconfig/#user-guide-to-configure-with-kconfig).
127+
128+
#### Pseudomodules
129+
130+
When devices have a common access interface, having a default configuration to
131+
enable them across platforms, without having to explicitly specify which modules
132+
to include, comes in handy. For this, `pseudomodules` are defined:
133+
134+
##### SAUL Default
135+
136+
Will enable all the drivers of sensors and actuators that are
137+
present in the target platform.
138+
139+
```makefile
140+
USEMODULE += saul_default
141+
```
142+
143+
##### Netdev Default
144+
145+
Will enable all the drivers of network devices
146+
present in the target platform.
147+
148+
```makefile
149+
USEMODULE += netdev_default
150+
```
151+
98152
## Including Source Files in Subfolders
99153

100154
By default, all source files in an application's (or any RIOT module's) directory

0 commit comments

Comments
 (0)