Skip to content

Commit 9c13ae1

Browse files
committed
doc: glossary: Consolidate "software component" as a term
In order to define different parts of the Zephyr codebase, we first need a clear term that defines what a "part of the software" is, so generalize the existing term "software component" to be used from now on as the standardized term. Given that the kernel is currently defined, as per: https://docs.zephyrproject.org/latest/kernel/services/index.html as: "The Zephyr kernel lies at the heart of every Zephyr application. It provides a low footprint, high performance, multi-threaded execution environment with a rich set of available features. The rest of the Zephyr ecosystem, including device drivers, networking stack, and application-specific code, uses the kernel’s features to create a complete application." label it as a software component as well. Signed-off-by: Carles Cufi <[email protected]>
1 parent 61a8648 commit 9c13ae1

File tree

2 files changed

+10
-9
lines changed

2 files changed

+10
-9
lines changed

doc/glossary.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -127,8 +127,9 @@ Glossary of Terms
127127
executing on the processor.
128128

129129
kernel
130-
The set of Zephyr-supplied files that implement the Zephyr kernel,
131-
including its core services, device drivers, network stack, and so on.
130+
The :term:`software component` in Zephyr that provides the
131+
hardware-agnostic core of the RTOS, including booting, threading,
132+
scheduling, synchronization, user mode, memory management and more.
132133

133134
power domain
134135
A power domain is a collection of devices for which power is
@@ -169,9 +170,9 @@ Glossary of Terms
169170
features, and that the vendor typically names and markets together.
170171

171172
software component
172-
A software component is a self-contained, modular, and replaceable part of
173-
the Zephyr source code. A driver, a subsystem or an applications are all
174-
examples of software components present in Zephyr.
173+
A software component is a well-defined and modular part of
174+
the Zephyr source code. The kernel, a driver, a library, a subsystem or a
175+
sample are all examples of software components present in Zephyr.
175176

176177
subsystem
177178
A subsystem refers to a logically distinct part of the operating system

doc/introduction/index.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,11 @@ The Zephyr kernel supports multiple architectures, including:
2323

2424
The full list of supported boards based on these architectures can be found :ref:`here <boards>`.
2525

26-
In the context of the Zephyr OS, a :term:`subsystem` refers to a logically distinct
26+
In the context of the Zephyr OS, a :term:`software component` refers to a logically distinct
2727
part of the operating system that handles specific functionality or provides
28-
certain services. Subsystems can include components such as networking,
28+
certain services. Zephyr contains software components such as networking,
2929
file systems, device driver classes, power management, and communication protocols,
30-
among others. Each subsystem is designed to be modular and can be configured,
30+
among others. Each software component is designed to be modular and can be configured,
3131
customized, and extended to meet the requirements of different embedded
3232
applications.
3333

@@ -182,7 +182,7 @@ Zephyr offers a large and ever growing number of features including:
182182

183183
**Native port**
184184
:zephyr:board:`Native sim <native_sim>` allows running Zephyr as a Linux application with support
185-
for various subsystems and networking.
185+
for most components, including networking.
186186

187187

188188
.. include:: ../../README.rst

0 commit comments

Comments
 (0)