Skip to content

Commit

Permalink
doc/mainpage: don't claim to be a microkernel
Browse files Browse the repository at this point in the history
We are clearly not and this just sets wrong expectations.
  • Loading branch information
benpicco committed Jan 11, 2024
1 parent bb4c4dd commit ca97f8a
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion core/doc.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
6 changes: 3 additions & 3 deletions doc/doxygen/src/mainpage.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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) ,
Expand Down

0 comments on commit ca97f8a

Please sign in to comment.