chrysn
f7dfa2f84d
Merge pull request #17133 from chrysn-pull-requests/doc-develhelp-stackoverflow-precision
...
doc: Start documenting pseudomodules
2022-01-27 15:09:22 +01:00
chrysn
68d0c291a9
doc: Initial documentation of pseudomodules
...
Co-authored-by: Francisco <femolina@uc.cl>
2022-01-27 13:49:14 +01:00
Leandro Lanzieri
6257442e4e
doc: Add project name
2022-01-19 10:17:52 +01:00
Marian Buschsieweke
d788bd327d
Merge pull request #17504 from chrysn-pull-requests/doc-c2rust-locked
...
doc: Fix C2Rust installation procedure
2022-01-17 17:40:38 +01:00
chrysn
e7a9e125d4
doc: Point to test README for details
2022-01-13 12:52:09 +01:00
chrysn
acbbb405b0
doc: Fix C2Rust installation procedure
...
The `--locked` is required since dependencies increased their MSRV to
something later than C2Rust's fixed nightly. That was already reflected
in the riotdocker installation steps, but not here where the line was
taken from upstream's docs.
Closes: https://github.com/RIOT-OS/RIOT/issues/17492
2022-01-12 08:56:13 +01:00
23ab8431a7
Merge pull request #17412 from jenswet/feature/cpp-doxygen-documentation
...
doc: Improve C++ documentation
2021-12-21 12:32:47 +01:00
chrysn
9b66bd59e1
rust: Add overview documentation
2021-12-19 11:15:04 +01:00
Jens Wetterich
a0930a8ec0
doc: Improve C++ documentation
...
Move C++ modules in a new menu tree and improve the description.
2021-12-15 18:58:23 +01:00
Leandro Lanzieri
c8533e6f23
doc/kconfig: add information on default configurations
2021-12-13 12:33:24 +01:00
Francisco Molina
cc001a81e1
Makefile.base: add SUBMODULE_NO_SRC to excluded a selected SUBMODULE *.c
...
This allows for SUBMODULE PSEUDOMODULES to conditionally not be linked
to an existing *.c file.
2021-11-16 22:40:11 +01:00
Leandro Lanzieri
f64b166319
Merge pull request #16845 from MrKevinWeiss/pr/kconfig/supportstms
...
.murdock: Add nucleo boards to kconfig test
2021-11-01 09:55:22 +01:00
Jnae
5bb4d29aed
doc/getting-started.md: added beginner friendly instructions
2021-10-27 08:15:42 +02:00
benpicco
ca1ab67a9d
Merge pull request #17002 from maribu/doc/getting-started
...
doc/.../getting-started.md: update software requirements
2021-10-20 14:02:05 +02:00
Marian Buschsieweke
ba859613d4
doc/.../getting-started.md: update software requirements
2021-10-19 11:26:42 +02:00
Benjamin Valentin
ccae474cf8
doc/porting-boards.md: update documentation of board_init()
2021-10-18 12:33:48 +02:00
MrKevinWeiss
c9ffb8d2af
board/common/nucleo: Use and doc HAVE_* Kconfig
2021-10-14 11:28:42 +02:00
3274bbb1cf
doc/emulators: documented info-emulated-boards target
2021-10-12 10:42:49 +02:00
benpicco
a39c0e1010
Merge pull request #16750 from benpicco/gnrc_ipv6_auto_subnets
...
gnrc/ipv6_auto_subnets: relax topology requirements
2021-09-28 19:07:21 +02:00
Benjamin Valentin
6742fb8076
gnrc/ipv6_auto_subnets: relax topology requirements
2021-09-28 16:57:10 +02:00
Martine Lenders
77f7db1e0d
Merge pull request #15981 from miri64/doc/enh/porting-graph
...
doc/porting-boards.md: improve with porting graph and reference section
2021-09-16 18:53:40 +02:00
Martine Lenders
aaa9512d50
doc/porting-boards.md: improve with porting graph and reference section
2021-09-16 16:54:42 +02:00
Kevin "Tristate Tom" Weiss
73e32207df
Merge pull request #16052 from miri64/dist/enh/genconfig-env
...
makefiles/kconfig.mk: generate config file from RIOT_CONFIG_% environment variables
2021-09-08 11:00:59 +02:00
Martine Lenders
5a44f6b4cf
doc: add documentation on RIOT_CONFIG_ variables
2021-09-07 11:23:12 +02:00
d96a7f98c7
Merge pull request #16810 from fjmolinas/pr_no_udev_link
...
doc/doxygen/src/advanced-build-system-tricks: fix no udev link
2021-09-03 20:20:37 +02:00
Francisco Molina
b26e4c0116
doc/doxygen/src/advanced-build-system-tricks: fix no udev link
2021-09-03 19:28:52 +02:00
benpicco
9ac9b41a57
Merge pull request #16536 from benpicco/gnrc_ipv6_nib_subnets
...
gnrc_ipv6_simple_subnets: auto-configuration for nested subnets on a simple tree topology
2021-09-02 16:24:53 +02:00
Benjamin Valentin
b208db0f27
gnrc_ipv6_auto_subnets: auto-configuration for nested subnets
...
If we get a large (e.g. /62) prefix from e.g. DHCPv6, we can split it
into subnets automatically to configure downstream interfaces.
This allows for automatic configuration of daisy-chained nodes or
nodes connected in a tree topology.
To enable the feature, a new pseudo-module `gnrc_ipv6_auto_subnets` is
provided.
2021-09-02 15:35:14 +02:00
Martine Lenders
1bf18b3239
doc/doxygen/riot.doxyfile: remove obsolete and fix wrong options
2021-08-31 19:20:37 +02:00
dylad
c488f96971
doc/doxygen: increase DOT_GRAPH_MAX_NODES to 275
2021-07-27 21:20:34 +02:00
062c0e550c
doxygen: Replace Freenode IRC with the Matrix room
...
Can be replace and/or extended with a new IRC room as soon as the poll
is closed:
https://forum.riot-os.org/t/riot-irc-channel-and-the-freenode-turmoil/3242/28
2021-06-18 11:05:26 +02:00
Martine Lenders
0978084d1e
Merge pull request #16345 from miri64/doc/enh/release-cycle
...
doc: README: Add documentation on downloads and release cycle
2021-05-17 09:48:53 +02:00
Jean Pierre Dudey
33539f137a
Merge pull request #16428 from bergzand/pr/readme/remove_ml
...
Documentation: Remove mentions of the users@ and devel@ mailing lists.
2021-05-12 13:44:07 +02:00
059be06217
doxygen: Remove users@ and devel@ mailing lists
2021-05-12 11:41:25 +02:00
Francisco
8cb8bba4e7
Merge pull request #16104 from maribu/external_modules
...
build system: Rework EXTERNAL_MODULE_DIRS
2021-05-07 23:27:17 +02:00
Marian Buschsieweke
6ac8aba955
build system: rework EXTERNAL_MODULE_DIRS
...
Previously, external modules had to be individually added to both
EXTERNAL_MODULE_DIRS and USEMODULE. If those where not in sync, this
resulted in build errors.
With this commit, search folders for external modules are added to
EXTERNAL_MODULE_DIRS instead. So lets say the file system structure is
like this
```
└── /path/to/external/modules
├── mod_a
│ ├── Makefile
│ ├── Makefile.dep
│ ├── Makefile.include
│ ├── foo.c
│ └── include
│ └── external_module.h
└── mod_b
├── Makefile
└── bar.c
```
One now adds `/path/to/external/modules` to EXTERNAL_MODULES and only
with `USEMODULE += mod_a` the corresponding module, dependencies and
include settings are actually used. Hence, it is possible to configure
`EXTERNAL_MODULE_DIRS` from `~/.profile` or `~/.bashrc` once and never
needs to worry about them again.
2021-05-07 21:29:05 +02:00
Leandro Lanzieri
d7f6387019
doc/rdm1: fix URL to poster abstract
2021-05-05 10:00:48 +02:00
Leandro Lanzieri
ec3e540931
doc/mainpage: fix RIOT paper URL
2021-05-05 09:41:48 +02:00
Martine Lenders
af7152eeca
doxygen: add release cycle page
2021-05-04 11:54:15 +02:00
Marian Buschsieweke
a07dac9ad1
build system: add new compile-commands make target
...
By running make compile-commands a `compile_commands.json` in the RIOT base
directory. With the environment variable `COMPILE_COMMANDS` the path of
this file can be changed to a custom location.
The `compile_commands.json` will contain the exact compile command, but
as additional flag `-I/usr/$(TARGET)/include` is added to work around
`clangd` not being able to locate the newlib system headers. The
additional includes can be overwritten using the environment variable
`COMPILE_COMMANDS_EXTRA_INCLUDES`.
2021-04-14 14:51:46 +02:00
Leandro Lanzieri
79fe7274ca
doc: add documentation on default configurations
2021-03-10 14:18:09 +01:00
chrysn
204a608c24
doc: Make bootloaders visible in modules
2021-02-18 14:56:20 +01:00
chrysn
711e9ab3b6
doc: Warn against blocking in board_init
2021-02-15 06:01:29 +01:00
Akshai M
b9d84e0b3e
doc/porting-cpus.md: initial import of a CPU porting guide
2021-02-10 15:45:59 +01:00
c9e0604612
doc: add emulator documentation
2021-01-13 17:14:39 +01:00
Martine Lenders
d145b0d7d8
doc: generate-changelog: add support for point releases
2021-01-08 14:46:10 +01:00
b8efd8425d
doc/kconfig: fix typo (bellow => below)
2021-01-08 10:15:32 +01:00
Martine Lenders
a28af88e02
doc: add link to forum on the main page
2020-12-10 10:10:03 +01:00
b31357eccc
doc: update Makefile.include instructions
...
Specify the programmer using the PROGRAMMER variable, don't include programmer specific makefile and serial makefile
2020-12-02 11:57:10 +01:00
Karl Fessel
2e9bdf0635
doc: add jquerry.scrollTo for less timers in html doc
...
see #15503
add jquerry.scrollTo
add the code to copy and load scrollTo
2020-11-24 20:28:47 +01:00
