From ca97f8ab2b6af4cadb1d3bd3709be84bb65e3e11 Mon Sep 17 00:00:00 2001 From: Benjamin Valentin Date: Thu, 11 Jan 2024 16:54:21 +0100 Subject: [PATCH] doc/mainpage: don't claim to be a microkernel We are clearly not and this just sets wrong expectations. --- core/doc.txt | 2 +- doc/doxygen/src/mainpage.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/core/doc.txt b/core/doc.txt index 8fd5685070..8a0273e6ff 100644 --- a/core/doc.txt +++ b/core/doc.txt @@ -8,7 +8,7 @@ /** * @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, * threading, synchronization and IRQ-handling. diff --git a/doc/doxygen/src/mainpage.md b/doc/doxygen/src/mainpage.md index 18e3c89a63..299b39df3f 100644 --- a/doc/doxygen/src/mainpage.md +++ b/doc/doxygen/src/mainpage.md @@ -5,14 +5,14 @@ RIOT Documentation {#mainpage} 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 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. -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, priority queues), a shell and more. RIOT supports a wide range of microcontroller architectures, radio drivers, sensors, and configurations for @@ -167,7 +167,7 @@ See @ref drivers for more details. 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 nor device drivers can be found in this directory. The libraries include data structures (e.g. bloom, color), crypto libraries (e.g. hashes, AES) ,