RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
Code Releases Activity

doc/mainpage: don't claim to be a microkernel

Browse Source 
We are clearly not and this just sets wrong expectations.
This commit is contained in:
Benjamin Valentin 2024-01-11 16:54:21 +01:00
parent bb4c4ddf20
commit ca97f8ab2b
2 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
core/doc.txt
View File

@ -8,7 +8,7 @@
/** /**
* @defgroup core Kernel * @defgroup core Kernel
* @brief The RIOT micro-kernel containing the core functionality * @brief The RIOT kernel containing the core functionality
* *
* The kernel module contains the basic OS functionality such as the scheduler, * The kernel module contains the basic OS functionality such as the scheduler,
* threading, synchronization and IRQ-handling. * threading, synchronization and IRQ-handling.

6
doc/doxygen/src/mainpage.md
View File

@ -5,14 +5,14 @@ RIOT Documentation {#mainpage}
RIOT in a nutshell {#riot-in-a-nutshell} RIOT in a nutshell {#riot-in-a-nutshell}
================== ==================
RIOT is an open-source microkernel-based operating system, designed to match RIOT is an open-source microcontroller operating system, designed to match
the requirements of Internet of Things (IoT) devices and other embedded the requirements of Internet of Things (IoT) devices and other embedded
devices. These requirements include a very low memory footprint (on the order devices. These requirements include a very low memory footprint (on the order
of a few kilobytes), high energy efficiency, real-time capabilities, support of a few kilobytes), high energy efficiency, real-time capabilities, support
for a wide range of low-power hardware, communication stacks for wireless and for a wide range of low-power hardware, communication stacks for wireless and
communication stacks for wired networks. communication stacks for wired networks.
RIOT provides a microkernel, multiple network stacks, and utilities which RIOT provides threading, multiple network stacks, and utilities which
include cryptographic libraries, data structures (bloom filters, hash tables, include cryptographic libraries, data structures (bloom filters, hash tables,
priority queues), a shell and more. RIOT supports a wide range of priority queues), a shell and more. RIOT supports a wide range of
microcontroller architectures, radio drivers, sensors, and configurations for microcontroller architectures, radio drivers, sensors, and configurations for
@ -167,7 +167,7 @@ See @ref drivers for more details.
sys sys
--- ---
RIOT follows the micro-kernel design paradigm where everything is supposed to 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 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 nor device drivers can be found in this directory. The libraries include data
structures (e.g. bloom, color), crypto libraries (e.g. hashes, AES) , structures (e.g. bloom, color), crypto libraries (e.g. hashes, AES) ,