benpicco
ecbe686b03
Merge pull request #18455 from maribu/doc/doxygen/src/flashing.md
...
doc: Add high-level documentation on flashing boards
2022-08-16 21:12:32 +02:00
Benjamin Valentin
28ff28aee0
gnrc/ipv6_auto_subnets: document the role of the RIO
2022-08-16 11:31:23 +02:00
Benjamin Valentin
18e74ae8c0
gnrc/ipv6_auto_subnets: document subnet generation better
2022-08-16 11:31:23 +02:00
Marian Buschsieweke
cc451a5531
doc: Add documentation for TTY_BOARD_FILTER
2022-08-15 16:30:36 +02:00
Marian Buschsieweke
1fd908bd70
doc: Move flashing tips to flashing.md
2022-08-15 16:27:19 +02:00
Marian Buschsieweke
81c2f05fa9
doc: Add high level documentation on flashing
...
This is mostly intended as a place to add available configuration
options for each `<foo>` in `PROGRAMMER=<foo>`.
2022-08-15 16:18:16 +02:00
Benjamin Valentin
7812564d16
doc/doxygen: use DuckDuckGo for search
2022-07-22 14:39:51 +02:00
Benjamin Valentin
d4a3521501
doc/doxygen: add gnrc_ipv6_auto_subnets.c to INPUT
2022-07-15 11:47:01 +02:00
chrysn
d9879c96ca
Merge pull request #16833 from chrysn-pull-requests/rust-lib
...
Add some Rust library building infrastructure
2022-07-10 21:39:35 +02:00
chrysn
cd6393a4d3
doc: Update for Rust libraries
...
Co-authored-by: Marian Buschsieweke <marian.buschsieweke@ovgu.de>
2022-07-10 21:27:12 +02:00
Marian Buschsieweke
fcbba02daf
Merge pull request #18256 from Teufelchen1/chore/macos
...
Documentation: Renaming OS X to macOS
2022-06-30 07:05:48 +02:00
Teufelchen1
1231807bab
Documentation: Renaming OS X to macOS
2022-06-23 17:25:48 +02:00
chrysn
5cde02177c
rust: Explicitly select nightly
...
Examples have previously relied on the (really: some) nightly toolchain
to be the default. As that, in practice, is a problematic assumption,
the latest toolchain to use is now determined programmatically, and that
is set explicitly on the examples that use nightly.
Workaround-For: https://github.com/rust-lang/rustup/issues/3015
2022-06-22 12:07:45 +02:00
chrysn
1e7ac17e07
doc/rust: Migrate and modernize text from rust_minimal README
...
This is a rewrite of text that has come to be quite outdated, pulled
into the central location for information about RIOT's Rust integration.
2022-06-15 00:01:27 +02:00
chrysn
af0e673c04
doc/rust: Updates on Rust and C2Rust versions
...
This better reflects the current state of things. Setting the nightly
toolchain as default works better for new users with the current
settings of the examples. Not pinning the C2Rust version -- we don't pin
the nightly version in the docs either, and breakage is easy to track
given the container builds as a base line.
2022-06-14 23:02:11 +02:00
chrysn
6b49a391c8
doc/rust: Typo and link fixes
2022-06-14 22:52:03 +02:00
Chris Moore
6e90780190
doc: fix broken link/footnote in using-rust/maintenance
2022-04-17 19:32:47 -05:00
chrysn
82a91d7ef4
doc/rust: Update to cover stable installation
2022-04-07 10:02:00 +02:00
Francisco Molina
c16119b815
doc/doxygen: recommend adding ADJUST ztimer values for new boards
2022-03-23 10:04:02 +01:00
Francisco Molina
822bef48da
doc/doxygen: add BUILD_IN_DOCKER extended doc
2022-03-18 07:57:50 +01:00
chrysn
cd1c64c8ff
Merge pull request #17737 from maribu/dist/tools/usb-serial
...
dist/tools/usb_serial: Add tool for listing and filtering TTY interfaces
2022-03-10 13:19:58 +01:00
Marian Buschsieweke
b296ade6b2
dist/tools/usb-serial: Add ttys.py
...
- Provide a new tool to list and filter TTYs
- Change `Makefile.include` to use `$(RIOTTOOLS)/usb-serial/ttys.py`
instead of `$(Q)$(RIOTTOOLS)/usb-serial/list-ttys.sh` to implement
`make list-ttys`
- Extend `makefiles/tools/serial.inc.mk` to allow using the most recent
port by passing `MOST_RECENT_PORT=1` as environment variable or
parameter to make
Co-authored-by: chrysn <chrysn@fsfe.org>
Co-authored-by: Koen Zandberg <koen@bergzand.net>
2022-03-09 15:40:36 +01:00
chrysn
01573a154a
doc: C2Rust does not need patching any more.
2022-03-09 12:09:30 +01:00
chrysn
f4c298fc32
doc/rust: Note that stable Rust can be used with some examples
...
Closes: https://github.com/RIOT-OS/RIOT/issues/17526
2022-03-08 12:44:49 +01:00
7e587b068e
Merge pull request #17756 from gschorcht/doc/fix_getitng_started_docker
...
doc: small fix of "Getting Started" document structure in section docker
2022-03-07 07:47:50 +01:00
Gunar Schorcht
4220f65bf8
doc: remove backticks from headings in "Getting Started"
...
Backticks in headings no longer seem to work in doxygen markdown support.
2022-03-06 23:41:28 +01:00
Gunar Schorcht
d1fd11c2f5
doc: fix "Getting Started" structure for section docker
...
Fixes two problems:
- Section "Usage" which describes the usage of docker is on heading level 1 but has to be on heading level 2
- Section "Setup" has only one subsection. A second subsection was added. Now, the section "Setup" has two subsections, one that describes the installation of docker and one that describes downloading and testing of the RIOT docker build image.
2022-03-06 23:41:28 +01:00
eec8b7a8d4
tree-wide: emulators: s/RUNTIME_TMP_DIR/EMULATOR_TMP_DIR
2022-03-04 13:44:51 +01:00
7cc5787ecb
doc/emulator: update EMULATOR_SERIAL_PORT documentation
2022-03-04 13:34:57 +01:00
38a263efab
doc/emulator: update qemu doc with unix sockets
2022-03-04 13:30:14 +01:00
chrysn
6fbf36cdf4
doc/memo: Link to RDMs in development
2022-03-02 15:08:15 +01:00
Karl Fessel
52116e1070
Merge pull request #17572 from kfessel/p-set-doxygen-example-path
...
doc: add RIOT root to doxygen example path
2022-02-28 15:42:25 +01:00
chrysn
204a622fc3
doc/rust: Remove duplicate (and wrong) line
...
The duplication happened already in the initial version, and when
[17504] had the `--locked` added, the opportunity to remove the
duplication was missed.
[17504]: https://github.com/RIOT-OS/RIOT/pull/17504
2022-02-24 16:53:02 +01:00
Benjamin Valentin
35ecfadf54
doc/porting-boards.md: update documentation of board_init()
2022-02-22 18:27:37 +01:00
aaa2a7939d
doc: introduce debugging-aids.md, start with ubsan
2022-02-16 12:20:45 +01:00
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
Karl Fessel
fb9bd122b3
doc: set example path to RIOT root
2022-01-25 17:26:38 +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
