From e2927ed326d19ef1677d5a3596f4a0e4f6419132 Mon Sep 17 00:00:00 2001 From: AnnsAnn Date: Fri, 5 Dec 2025 15:36:13 +0100 Subject: [PATCH] doc/doxygen: remove deprecated pages --- doc/doxygen/Makefile | 16 +- doc/doxygen/riot.doxyfile | 27 - doc/doxygen/src/LOSTANDFOUND.md | 5 - .../src/advanced-build-system-tricks.md | 6 - doc/doxygen/src/build-in-docker.md | 6 - doc/doxygen/src/build-system-basics.md | 5 - doc/doxygen/src/changelog-deprecated.md | 6 - doc/doxygen/src/coc-deprecated.md | 5 - doc/doxygen/src/coc-faq.md | 4 - doc/doxygen/src/coc-info.md | 5 - doc/doxygen/src/coc-reporting-guide.md | 4 - doc/doxygen/src/creating-an-application.md | 5 - doc/doxygen/src/creating-modules.md | 5 - doc/doxygen/src/debugging-aids.md | 4 - doc/doxygen/src/dev-best-practices.md | 4 - doc/doxygen/src/driver-guide.md | 5 - doc/doxygen/src/emulators.md | 5 - doc/doxygen/src/flashing.md | 5 - doc/doxygen/src/getting-started.md | 42 -- doc/doxygen/src/governance-deprecated.md | 5 - doc/doxygen/src/io-mapping-and-shields.md | 5 - doc/doxygen/src/kconfig/kconfig.md | 4 - doc/doxygen/src/mainpage.md | 236 +------- doc/doxygen/src/porting-boards.md | 5 - doc/doxygen/src/release-cycle.md | 5 - doc/doxygen/src/riot-structure.svg | 537 ------------------ doc/doxygen/src/roadmap.md | 4 - doc/doxygen/src/terminal-programs.md | 5 - doc/doxygen/src/using-cpp.md | 5 - doc/doxygen/src/using-rust.md | 5 - doc/doxygen/src/vision.md | 3 - drivers/lsm303agr/doc.txt | 3 +- sys/arduino/doc.txt | 3 +- 33 files changed, 13 insertions(+), 976 deletions(-) delete mode 100644 doc/doxygen/src/LOSTANDFOUND.md delete mode 100644 doc/doxygen/src/advanced-build-system-tricks.md delete mode 100644 doc/doxygen/src/build-in-docker.md delete mode 100644 doc/doxygen/src/build-system-basics.md delete mode 100644 doc/doxygen/src/changelog-deprecated.md delete mode 100644 doc/doxygen/src/coc-deprecated.md delete mode 100644 doc/doxygen/src/coc-faq.md delete mode 100644 doc/doxygen/src/coc-info.md delete mode 100644 doc/doxygen/src/coc-reporting-guide.md delete mode 100644 doc/doxygen/src/creating-an-application.md delete mode 100644 doc/doxygen/src/creating-modules.md delete mode 100644 doc/doxygen/src/debugging-aids.md delete mode 100644 doc/doxygen/src/dev-best-practices.md delete mode 100644 doc/doxygen/src/driver-guide.md delete mode 100644 doc/doxygen/src/emulators.md delete mode 100644 doc/doxygen/src/flashing.md delete mode 100644 doc/doxygen/src/getting-started.md delete mode 100644 doc/doxygen/src/governance-deprecated.md delete mode 100644 doc/doxygen/src/io-mapping-and-shields.md delete mode 100644 doc/doxygen/src/kconfig/kconfig.md delete mode 100644 doc/doxygen/src/porting-boards.md delete mode 100644 doc/doxygen/src/release-cycle.md delete mode 100644 doc/doxygen/src/riot-structure.svg delete mode 100644 doc/doxygen/src/roadmap.md delete mode 100644 doc/doxygen/src/terminal-programs.md delete mode 100644 doc/doxygen/src/using-cpp.md delete mode 100644 doc/doxygen/src/using-rust.md delete mode 100644 doc/doxygen/src/vision.md diff --git a/doc/doxygen/Makefile b/doc/doxygen/Makefile index 4176df47b2..b382133a05 100644 --- a/doc/doxygen/Makefile +++ b/doc/doxygen/Makefile @@ -78,17 +78,17 @@ doc-ci: $(RIOTTOOLS)/doxygen/Makefile # by marking html as phony we force make to re-run Doxygen even if the directory exists. .PHONY: html -html: src/changelog.md src/coc.md src/governance.md +html: src/changelog.md ( cat riot.doxyfile ; echo "GENERATE_HTML = yes" ) | $(DOXYGEN) - @echo "" @echo "RIOT documentation successfully generated at file://$(RIOTBASE)/doc/doxygen/html/index.html" .PHONY: check -check: src/changelog.md src/coc.md src/governance.md +check: src/changelog.md ( cat riot.doxyfile) | $(DOXYGEN) - .PHONY: man -man: src/changelog.md src/coc.md src/governance.md +man: src/changelog.md ( cat riot.doxyfile ; echo "GENERATE_MAN = yes" ) | $(DOXYGEN) - @echo "" @echo "RIOT documentation successfully generated at file://$(RIOTBASE)/doc/doxygen/man/man3" @@ -103,18 +103,12 @@ src/css/variables.less: src/config.json src/changelog.md: src/changelog.md.tmp ../../release-notes.txt @./generate-changelog.py $+ $@ -src/coc.md: ../../CODE_OF_CONDUCT.md - awk 'NR == 1 {print $$0,"{#coc}"} NR > 1 {print $$0}' $< > $@ - -src/governance.md: ../../GOVERNANCE.md - @sed 's//\[TOC\]\n\0/' $< | sed '//,//d' > $@ - .PHONY: -latex: src/changelog.md src/coc.md src/governance.md +latex: src/changelog.md ( cat riot.doxyfile ; echo "GENERATE_LATEX= yes" ) | $(DOXYGEN) - @echo "" @echo "RIOT documentation successfully generated at file://$(RIOTBASE)/doc/doxygen/latex/index.tex" clean: - -@rm -rf latex man html doxygen_objdb_*.tmp doxygen_entrydb_*.tmp src/changelog.md src/coc.md src/governance.md + -@rm -rf latex man html doxygen_objdb_*.tmp doxygen_entrydb_*.tmp src/changelog.md @$(MAKE) -C $(RIOTTOOLS)/doxygen clean diff --git a/doc/doxygen/riot.doxyfile b/doc/doxygen/riot.doxyfile index 97385e80ea..246a6ac1db 100644 --- a/doc/doxygen/riot.doxyfile +++ b/doc/doxygen/riot.doxyfile @@ -1006,35 +1006,8 @@ INPUT = ../../doc.txt \ ../../sys \ src/ \ src/mainpage.md \ - src/vision.md \ - src/governance-deprecated.md \ - src/roadmap.md \ - src/coc-info.md \ - src/coc-deprecated.md \ - src/coc-reporting-guide.md \ - src/coc-faq.md \ - src/creating-modules.md \ - src/creating-an-application.md \ - src/porting-boards.md \ - src/driver-guide.md \ - src/getting-started.md \ - src/flashing.md \ - src/terminal-programs.md \ - src/build-in-docker.md \ ../../tests/README.md \ - src/dev-best-practices.md \ - src/build-system-basics.md \ src/feature_list.md \ - src/kconfig/kconfig.md \ - src/using-cpp.md \ - src/using-rust.md \ - src/advanced-build-system-tricks.md \ - src/debugging-aids.md \ - src/emulators.md \ - src/release-cycle.md \ - src/io-mapping-and-shields.md \ - src/changelog-deprecated.md \ - src/LOSTANDFOUND.md \ ../../makefiles/pseudomodules.inc.mk \ ../../makefiles/blob.inc.mk \ ../../sys/net/gnrc/routing/ipv6_auto_subnets/gnrc_ipv6_auto_subnets.c \ diff --git a/doc/doxygen/src/LOSTANDFOUND.md b/doc/doxygen/src/LOSTANDFOUND.md deleted file mode 100644 index 26defcfc6a..0000000000 --- a/doc/doxygen/src/LOSTANDFOUND.md +++ /dev/null @@ -1,5 +0,0 @@ -Removed Features and Modules (Deprecated) {#md_LOSTANDFOUND} -============================ - -@deprecated Guides have moved to the [Guide Site](https://guide.riot-os.org/misc/lost_and_found/). -This page will be removed after release 2026.04. diff --git a/doc/doxygen/src/advanced-build-system-tricks.md b/doc/doxygen/src/advanced-build-system-tricks.md deleted file mode 100644 index 2c52589a82..0000000000 --- a/doc/doxygen/src/advanced-build-system-tricks.md +++ /dev/null @@ -1,6 +0,0 @@ -Advanced build system tricks (Deprecated) {#advanced-build-system-tricks} -============================ - -@deprecated See [Advanced Build System Tricks](https://guide.riot-os.org/build-system/advanced_build_system_tricks/) -on the RIOT Guide Site for the latest information. -This page will be removed after release 2025.11. diff --git a/doc/doxygen/src/build-in-docker.md b/doc/doxygen/src/build-in-docker.md deleted file mode 100644 index e330952212..0000000000 --- a/doc/doxygen/src/build-in-docker.md +++ /dev/null @@ -1,6 +0,0 @@ -# Build In Docker (Deprecated) {#build-in-docker} - -@deprecated This page is deprecated. -See [Build in Docker](https://guide.riot-os.org/build-system/build-in-docker/) -on the RIOT Guide Site for the latest information. -This page will be removed after release 2025.11. diff --git a/doc/doxygen/src/build-system-basics.md b/doc/doxygen/src/build-system-basics.md deleted file mode 100644 index ad9d57499e..0000000000 --- a/doc/doxygen/src/build-system-basics.md +++ /dev/null @@ -1,5 +0,0 @@ -# Build System Basics (Deprecated) {#build-system-basics} - -@deprecated See [Build System Basics](https://guide.riot-os.org/build-system/build_system_basics/) -on the RIOT Guide Site for the latest information. -This page will be removed after release 2025.11. diff --git a/doc/doxygen/src/changelog-deprecated.md b/doc/doxygen/src/changelog-deprecated.md deleted file mode 100644 index 2150d66b2f..0000000000 --- a/doc/doxygen/src/changelog-deprecated.md +++ /dev/null @@ -1,6 +0,0 @@ -# Changelog (Deprecated) {#changelog} - -@deprecated This page is deprecated. -See [Changelog](https://guide.riot-os.org/changelog) -on the RIOT Guide Site for the latest information. -This page will be removed after release 2026.04. diff --git a/doc/doxygen/src/coc-deprecated.md b/doc/doxygen/src/coc-deprecated.md deleted file mode 100644 index ec1e38f359..0000000000 --- a/doc/doxygen/src/coc-deprecated.md +++ /dev/null @@ -1,5 +0,0 @@ -Code of Conduct (Deprecated) {#coc-deprecated} -=============== - -@deprecated Guides have moved to the [Guide Site](https://guide.riot-os.org/general/code_of_conduct/). -This page will be removed after release 2026.04. diff --git a/doc/doxygen/src/coc-faq.md b/doc/doxygen/src/coc-faq.md deleted file mode 100644 index 3bce1a01b3..0000000000 --- a/doc/doxygen/src/coc-faq.md +++ /dev/null @@ -1,4 +0,0 @@ -# FAQ (Deprecated) {#coc-faq} - -@deprecated Guides have moved to the [Guide Site](https://guide.riot-os.org/general/code_of_conduct/faq/). -This page will be removed after release 2026.04. diff --git a/doc/doxygen/src/coc-info.md b/doc/doxygen/src/coc-info.md deleted file mode 100644 index d191a36bfe..0000000000 --- a/doc/doxygen/src/coc-info.md +++ /dev/null @@ -1,5 +0,0 @@ -Code of Conduct Information (Deprecated) {#coc-info} -=========================== - -@deprecated Guides have moved to the [Guide Site](https://guide.riot-os.org/general/code_of_conduct/). -This page will be removed after release 2026.04. diff --git a/doc/doxygen/src/coc-reporting-guide.md b/doc/doxygen/src/coc-reporting-guide.md deleted file mode 100644 index a81d93415b..0000000000 --- a/doc/doxygen/src/coc-reporting-guide.md +++ /dev/null @@ -1,4 +0,0 @@ -# Reporting Guidelines (Deprecated) {#coc-reporting-guide} - -@deprecated Guides have moved to the [Guide Site](https://guide.riot-os.org/general/code_of_conduct/reporting/). -This page will be removed after release 2026.04. diff --git a/doc/doxygen/src/creating-an-application.md b/doc/doxygen/src/creating-an-application.md deleted file mode 100644 index eb9f09a321..0000000000 --- a/doc/doxygen/src/creating-an-application.md +++ /dev/null @@ -1,5 +0,0 @@ -Creating an application (Deprecated) {#creating-an-application} -======================= - -@deprecated Guides have moved to the [Guide Site](https://guide.riot-os.org/advanced_tutorials/creating_application/). -This page will be removed after release 2026.04. diff --git a/doc/doxygen/src/creating-modules.md b/doc/doxygen/src/creating-modules.md deleted file mode 100644 index 42c1ee7664..0000000000 --- a/doc/doxygen/src/creating-modules.md +++ /dev/null @@ -1,5 +0,0 @@ -Creating modules (Deprecated) {#creating-modules} -================ - -@deprecated Guides have moved to the [Guide Site](https://guide.riot-os.org/advanced_tutorials/creating_modules/). -This page will be removed after release 2026.04. diff --git a/doc/doxygen/src/debugging-aids.md b/doc/doxygen/src/debugging-aids.md deleted file mode 100644 index 902b9ef5eb..0000000000 --- a/doc/doxygen/src/debugging-aids.md +++ /dev/null @@ -1,4 +0,0 @@ -# Debugging Tools (Deprecated) {#debugging-tools} - -@deprecated Guides have moved to the [Guide Site](https://guide.riot-os.org/build-system/debugging_aids/). -This page will be removed after release 2026.04. diff --git a/doc/doxygen/src/dev-best-practices.md b/doc/doxygen/src/dev-best-practices.md deleted file mode 100644 index 0a7e345cdf..0000000000 --- a/doc/doxygen/src/dev-best-practices.md +++ /dev/null @@ -1,4 +0,0 @@ -# Hints for quicker & better RIOT development (Deprecated) {#dev-best-practices} - -@deprecated Guides have moved to the [Guide Site](https://guide.riot-os.org/misc/dev_best_practices/). -This page will be removed after release 2026.04. diff --git a/doc/doxygen/src/driver-guide.md b/doc/doxygen/src/driver-guide.md deleted file mode 100644 index d0af6892fa..0000000000 --- a/doc/doxygen/src/driver-guide.md +++ /dev/null @@ -1,5 +0,0 @@ -Writing a Device Driver in RIOT (Deprecated) {#driver-guide} -=============================== - -@deprecated Guides have moved to the [Guide Site](https://guide.riot-os.org/advanced_tutorials/device_drivers/). -This page will be removed after release 2026.04. diff --git a/doc/doxygen/src/emulators.md b/doc/doxygen/src/emulators.md deleted file mode 100644 index 85445effc3..0000000000 --- a/doc/doxygen/src/emulators.md +++ /dev/null @@ -1,5 +0,0 @@ -Emulators (Deprecated) {#emulators} -========= - -@deprecated Guides have moved to the [Guide Site](https://guide.riot-os.org/misc/emulators/). -This page will be removed after release 2026.04. diff --git a/doc/doxygen/src/flashing.md b/doc/doxygen/src/flashing.md deleted file mode 100644 index 84a4a3782d..0000000000 --- a/doc/doxygen/src/flashing.md +++ /dev/null @@ -1,5 +0,0 @@ -Flashing via RIOT's Build System (Deprecated) {#flashing} -================================ - -@deprecated Guides have moved to the [Guide Site](https://guide.riot-os.org/build-system/flashing/). -This page will be removed after release 2026.04. diff --git a/doc/doxygen/src/getting-started.md b/doc/doxygen/src/getting-started.md deleted file mode 100644 index bdad909a69..0000000000 --- a/doc/doxygen/src/getting-started.md +++ /dev/null @@ -1,42 +0,0 @@ -Getting started (Deprecated) {#getting-started} -=============== - -@deprecated Guides have moved to the [Guide Site](https://guide.riot-os.org/getting-started/installing/). -This page will be removed after release 2026.04. - -[TOC] - -@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. - -The build system {#the-build-system} ----------------- - -@deprecated See [The Build System](https://guide.riot-os.org/build-system/build_system/) on the RIOT Guide Site for the latest information. This section will be removed after release 2025.11. - - -Building and executing an example {#building-and-executing-an-example} ---------------------------------- -@deprecated See [Building and executing an example](https://guide.riot-os.org/getting-started/building_example/) on the RIOT Guide Site for the latest information. This section will be removed after release 2025.11. - -Configuring an application {#configuring-an-application} --------------------------- -@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. - -Default configurations {#default-configurations} ----------------------- -@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. - -Use Docker to build RIOT {#docker} -======================== - -@deprecated See [Setup Guide](https://guide.riot-os.org/getting-started/installing/) or [Build in Docker](https://guide.riot-os.org/build-system/build-in-docker/) on the RIOT Guide Site for the latest information. This section will be removed after release 2025.11. - -Generating compile_commands.json e.g. for code completion in IDEs -================================================================= - -@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. - -Using the native port with networking -===================================== - -@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. diff --git a/doc/doxygen/src/governance-deprecated.md b/doc/doxygen/src/governance-deprecated.md deleted file mode 100644 index f815167595..0000000000 --- a/doc/doxygen/src/governance-deprecated.md +++ /dev/null @@ -1,5 +0,0 @@ -Governance of the RIOT Community (Deprecated) {#governance} -================================ - -@deprecated Guides have moved to the [Guide Site](https://guide.riot-os.org/general/governance/). -This page will be removed after release 2026.04. diff --git a/doc/doxygen/src/io-mapping-and-shields.md b/doc/doxygen/src/io-mapping-and-shields.md deleted file mode 100644 index 28b1f88a23..0000000000 --- a/doc/doxygen/src/io-mapping-and-shields.md +++ /dev/null @@ -1,5 +0,0 @@ -IO-Mapping and Shields (Deprecated) {#iomaps} -====================== - -@deprecated Guides have moved to the [Guide Site](https://guide.riot-os.org/misc/io_mapping_and_shields/). -This page will be removed after release 2026.04. diff --git a/doc/doxygen/src/kconfig/kconfig.md b/doc/doxygen/src/kconfig/kconfig.md deleted file mode 100644 index 1461f5fbd4..0000000000 --- a/doc/doxygen/src/kconfig/kconfig.md +++ /dev/null @@ -1,4 +0,0 @@ -# Kconfig in RIOT (Deprecated) {#kconfig-in-riot} - -@deprecated Guides have moved to the [Guide Site](https://guide.riot-os.org/build-system/kconfig/). -This page will be removed after release 2026.04. diff --git a/doc/doxygen/src/mainpage.md b/doc/doxygen/src/mainpage.md index 5d8bf76065..e9362cf027 100644 --- a/doc/doxygen/src/mainpage.md +++ b/doc/doxygen/src/mainpage.md @@ -1,237 +1,9 @@ -RIOT Documentation {#mainpage} +RIOT API Documentation {#mainpage} ================== [TOC] -RIOT in a nutshell {#riot-in-a-nutshell} -================== -RIOT is an open-source microcontroller operating system, designed to match -the requirements of Internet of Things (IoT) devices and other embedded -devices. These requirements include a very low memory footprint (on the order -of a few kilobytes), high energy efficiency, real-time capabilities, support -for a wide range of low-power hardware, communication stacks for wireless and -communication stacks for wired networks. +This is the Doxygen-generated API documentation of the RIOT operating system. -RIOT provides threading, multiple network stacks, and utilities which -include cryptographic libraries, data structures (bloom filters, hash tables, -priority queues), a shell and more. RIOT supports a wide range of -microcontroller architectures, radio drivers, sensors, and configurations for -entire platforms, e.g. Atmel SAM R21 Xplained Pro, Zolertia Z1, STM32 Discovery -Boards etc. (see the list of -[supported boards](https://www.riot-os.org/boards.html). -Across all supported hardware (32-bit, 16-bit, and 8-bit platforms), RIOT -provides a consistent API and enables C and C++ application programming, -with multithreading, IPC, system timers, mutexes etc. - -A good high-level overview can be found in the article -[RIOT: An Open Source Operating System for Low-End Embedded Devices in -the IoT](https://www.riot-os.org/assets/pdfs/riot-ieeeiotjournal-2018.pdf) -(IEEE Internet of Things Journal, December 2018). - -Contribute to RIOT {#contribute-to-riot} -================== -RIOT is developed by an open community that anyone is welcome to join: - - Download and contribute your code on - [GitHub](https://github.com/RIOT-OS/RIOT). You can read about how to - contribute [in our contributing - document](https://github.com/RIOT-OS/RIOT/blob/master/CONTRIBUTING.md). - - Sign-up to our [forum](https://forum.riot-os.org/) to ask for help using RIOT - or writing an application for RIOT, discuss kernel and network stack - development as well as hardware support, or to show-case your latest project. - - Follow us on [Mastodon][mastodon-link] for news from the RIOT - community. - - Regarding critical vulnerabilities we would appreciate if you give us a - 90-days head-start by reporting to security@riot-os.org, before making your - information publicly available - - Contact us on Matrix for live support and discussions: - [riot-os:matrix.org](https://matrix.to/#/#riot-os:matrix.org) - -[mastodon-link]: https://floss.social/@RIOT_OS - -Getting Started -================== - -To get started with RIOT, you can follow the -[Setup Guide](https://guide.riot-os.org/getting-started/installing/) on -the RIOT Guide Site. This guide will help you to set up your development -environment, build and run your first application, and configure RIOT for -your specific hardware. - - -Structure {#structure} -========= - -This section walks you through RIOT's structure. Once you understand this -structure, you will easily find your way around in RIOT's code base. - -![Overview](riot-structure.svg) - -RIOT's code base is structured into five groups. - - - The kernel (`core`) - - Platform specific code (`cpu`; `boards`) - - Device drivers (`drivers`) - - Libraries and network code (`sys`; `pkg`) - - Applications for demonstrating features and for testing (`examples`; - `tests`) - -In addition RIOT includes a collection of scripts for various tasks (`dist`) as -well as a predefined environment for generating this documentation (`doc`). - -The structural groups are projected onto the directory structure of RIOT, where -each of these groups resides in one or two directories in the main RIOT -directory. - -The following list gives a more detailed description of each of RIOT's -top-level directories: - -core ----- -This directory contains the actual kernel. The kernel consists of the scheduler, -inter-process-communication (messaging), threading, and thread -synchronization, as well as supporting data-structures and type definitions. - -See @ref core for further information and API documentations. - -boards ------- -The platform dependent code is split into two logic elements: CPUs and boards, -while maintaining a strict 1-to-n relationship, a board has exactly one CPU, -while a CPU can be part of n boards. The CPU part contains all generic, CPU -specific code (see below). - -The board part contains the specific configuration for the CPU it contains. -This configuration mainly includes the peripheral configuration and -pin-mapping, the configuration of on-board devices, and the CPU's clock -configuration. - -On top of the source and header files needed for each board, this directory -additionally may include some script and configuration files needed for -interfacing with the board. These are typically custom flash/debug scripts or -e.g. OpenOCD configuration files. For most boards, these files are located in a -`dist` sub-directory of the board. - -See here @ref boards for further information. - -cpu ---- -For each supported CPU this directory contains a sub-directory with the name of -the CPU. These directories then contain all CPU specific configurations, such -as implementations of power management (LPM), interrupt handling and vectors, -startup code, clock initialization code and thread handling (e.g. context -switching) code. For most CPUs you will also find the linker scripts in the -`ldscripts` sub-directory. - -In the `periph` sub-directory of each CPU you can find the implementations of -the CPU's peripheral drivers like SPI, UART, GPIO, etc. See @ref drivers_periph -for their API documentation. - -Many CPUs share a certain amount of their code (e.g. all ARM Cortex-M based -CPUs share the same code for task switching and interrupt handling). This -shared code is put in its own directories, following a `xxxxx_common` naming -scheme. Examples for this is code shared across architectures (e.g. -`cortexm_common`, `msp430_comon`) or code shared among vendors (e.g. -`stm32_common`). - -See @ref cpu for more detailed information. - -drivers -------- -This directory contains the drivers for external devices such as network -interfaces, sensors and actuators. Each device driver is put into its own -sub-directory with the name of that device. - -All of RIOT's device drivers are based on the peripheral driver API (e.g. SPI, -GPIO, etc.) and other RIOT modules like the `xtimer`. This way the drivers are -completely platform agnostic and they don't have any dependencies into the CPU -and board code. - -See @ref drivers for more details. - -sys ---- -RIOT follows a modular design paradigm where everything is supposed to -be a module. All of these modules that are not part of the hardware abstraction -nor device drivers can be found in this directory. The libraries include data -structures (e.g. bloom, color), crypto libraries (e.g. hashes, AES) , -high-level APIs (e.g. Posix implementations), memory management (e.g. malloc), -the RIOT shell and many more. - -See @ref sys for a complete list of available libraries - -sys/net -------- -The `sys/net` sub-directory needs to be explicitly mentioned, as this is where -all the networking code in RIOT resides. Here you can find the network stack -implementations (e.g. the @ref net_gnrc "GNRC" stack) as well as network stack agnostic code as -header definitions or network types. - -See @ref net for more details on networking code. - -pkg ---- -RIOT comes with support for a number of external libraries (e.g. -[ccn-lite](https://github.com/cn-uofbasel/ccn-lite), -[microcoap](https://github.com/1248/microcoap)). The way they are included is -that RIOT ships with a custom Makefile for each supported library that -downloads the library and optionally applies a number of patches to make it -work with RIOT. These Makefiles and patches can be found in the `pkg` -directory. - -See @ref pkg for a detailed description on how this works. - -examples --------- -Here you find a number of example applications that demonstrate certain -features of RIOT. The default example found in this directory is a good -starting point for anyone who is new to RIOT. - -For more information best browse that directory and have a look at the -`README.md` files that ship with each example. - -To create your own application - here or anywhere else - see @ref creating-an-application - -tests ------ -Many features/modules in RIOT come with their own test application, which are -located in this directory. In contrary to the examples these tests are mostly -focusing on a single aspect than on a set of features. Despite for testing, you -might consider these tests also for insights on understanding RIOT. - -dist & doc ----------- -All the tooling around RIOT can be found in these two folders. - -`doc` contains the doxygen configuration and also contains the compiled doxygen -output after running `make doc`. - -Lastly, the `dist` directory contains tools to help you with RIOT. These -include -the serial terminal application `pyterm`, generic scripts for flashing, -debugging, resetting (e.g. support for [OpenOCD](http://openocd.org/), -[Jlink](https://www.segger.com/jlink_base.html)), as well as code enabling easy -integration to open testbeds such as the [IoT-LAB](https://www.iot-lab.info/). -Furthermore you can find here scripts to do all kind of code and style checks. - -Further information {#further-information} -=================== - - @ref getting-started - - @ref creating-an-application - - @ref porting-boards - - @ref creating-modules - - @ref advanced-build-system-tricks - - @ref build-in-docker - - +If you are seeking for user guides, tutorials, or other documentation, please visit the +[RIOT Guide Site](https://guide.riot-os.org/). diff --git a/doc/doxygen/src/porting-boards.md b/doc/doxygen/src/porting-boards.md deleted file mode 100644 index cfaa70ad25..0000000000 --- a/doc/doxygen/src/porting-boards.md +++ /dev/null @@ -1,5 +0,0 @@ -Porting boards (Deprecated) {#porting-boards} -================ - -@deprecated Guides have moved to the [Guide Site](https://guide.riot-os.org/advanced_tutorials/porting_boards/). -This page will be removed after release 2026.04. diff --git a/doc/doxygen/src/release-cycle.md b/doc/doxygen/src/release-cycle.md deleted file mode 100644 index 195ff43d69..0000000000 --- a/doc/doxygen/src/release-cycle.md +++ /dev/null @@ -1,5 +0,0 @@ -Release cycle (Deprecated) {#release-cycle} -============= - -@deprecated Guides have moved to the [Guide Site](https://guide.riot-os.org/misc/release_cycle/). -This page will be removed after release 2026.04. diff --git a/doc/doxygen/src/riot-structure.svg b/doc/doxygen/src/riot-structure.svg deleted file mode 100644 index 79630f06aa..0000000000 --- a/doc/doxygen/src/riot-structure.svg +++ /dev/null @@ -1,537 +0,0 @@ - - - RIOT's structure - - - - image/svg+xml - - RIOT Overview - - - - Martine Lenders - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Hardware-independent - - Hardware-dependent - - - Application - - Hardware - - - pkg - - - - sys - - - - sys/net - - - - core (kernel) - - - - drivers - - - - drivers/periph - - - - cpu - - - - boards - - - diff --git a/doc/doxygen/src/roadmap.md b/doc/doxygen/src/roadmap.md deleted file mode 100644 index bfc3b342ca..0000000000 --- a/doc/doxygen/src/roadmap.md +++ /dev/null @@ -1,4 +0,0 @@ -# Roadmap (Deprecated) {#roadmap} - -@deprecated Roadmap has moved to the [Guide Site](https://guide.riot-os.org/misc/roadmap/). -This page will be removed after release 2026.04. diff --git a/doc/doxygen/src/terminal-programs.md b/doc/doxygen/src/terminal-programs.md deleted file mode 100644 index d4e65c2b57..0000000000 --- a/doc/doxygen/src/terminal-programs.md +++ /dev/null @@ -1,5 +0,0 @@ -Terminal programs configuration (Deprecated) {#terminal-programs} -=========================================================== - -@deprecated Guides have moved to the [Guide Site](https://guide.riot-os.org/misc/terminal_config/). -This page will be removed after release 2026.04. diff --git a/doc/doxygen/src/using-cpp.md b/doc/doxygen/src/using-cpp.md deleted file mode 100644 index a045b61533..0000000000 --- a/doc/doxygen/src/using-cpp.md +++ /dev/null @@ -1,5 +0,0 @@ -Using C++ in RIOT (Deprecated) {#using-cpp} -================== - -@deprecated Guides have moved to the [Guide Site](https://guide.riot-os.org/c_tutorials/using_cpp/). -This page will be removed after release 2026.04. diff --git a/doc/doxygen/src/using-rust.md b/doc/doxygen/src/using-rust.md deleted file mode 100644 index 9ced590952..0000000000 --- a/doc/doxygen/src/using-rust.md +++ /dev/null @@ -1,5 +0,0 @@ -Using Rust in RIOT (Deprecated) {#using-rust} -================== - -@deprecated Guides have moved to the [Guide Site](https://guide.riot-os.org/). -This page will be removed after release 2025.11. diff --git a/doc/doxygen/src/vision.md b/doc/doxygen/src/vision.md deleted file mode 100644 index f39bc6a8ad..0000000000 --- a/doc/doxygen/src/vision.md +++ /dev/null @@ -1,3 +0,0 @@ -# RIOT Vision (Deprecated) {#vision} - -@deprecated See [Vision](https://guide.riot-os.org/general/vision/) on the RIOT Guide Site for the latest information. This page will be removed after release 2025.11. diff --git a/drivers/lsm303agr/doc.txt b/drivers/lsm303agr/doc.txt index b007c3b8fc..8a3c71b63a 100644 --- a/drivers/lsm303agr/doc.txt +++ b/drivers/lsm303agr/doc.txt @@ -11,7 +11,8 @@ and based on the externally maintained [lsm303agr] crate. This means that: - it is only available on platforms supported by Rust, -- it needs Rust installed on the build machine as described in @ref using-rust, and +- it needs Rust installed on the build machine as described in + [Rust in RIOT](https://guide.riot-os.org/rust_tutorials/rust_in_riot/), and - it downloads additional Rust code from crates.io (in versions pinned by RIOT) when first used. [lsm303agr]: https://crates.io/crates/lsm303agr diff --git a/sys/arduino/doc.txt b/sys/arduino/doc.txt index 501e6e46f7..d4807bb1f5 100644 --- a/sys/arduino/doc.txt +++ b/sys/arduino/doc.txt @@ -103,7 +103,8 @@ * is required to be able to use * `analogRead()` and `analogWrite()`. * - * See also @ref iomaps on how a board can provide more I/O mappings and even + * See also [IO-Mapping and Shields](https://guide.riot-os.org/board_specific/io_mapping_and_shields/) + * on how a board can provide more I/O mappings and even * declare electrical and mechanical compatibility with common Arduino form * factors. *