michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: split kernel reference toctrees

Browse source 
Splitting these up by area helps make the sidebar a bit easier to
navigate, and will also let us insert additional overview information
about each area.

Signed-off-by: Marti Bolivar <marti.bolivar@nordicsemi.no>
This commit is contained in:
Marti Bolivar 2019-08-27 18:18:54 -06:00 • committed by Ioannis Glaropoulos
commit e9c858abc8
1 changed files with 46 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

50
doc/reference/kernel/index.rst
View file

@ -21,6 +21,11 @@ devices (like Wi-Fi and Bluetooth Low Energy), and complex multi-threading,
can also be developed using the Zephyr kernel. Examples of such systems can also be developed using the Zephyr kernel. Examples of such systems
include: fitness wearables, smart watches, and IoT wireless gateways. include: fitness wearables, smart watches, and IoT wireless gateways.
Scheduling, Interrupts, and Synchronization
*******************************************
These pages cover basic kernel services related to thread scheduling and
synchronization.
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
@ -28,22 +33,59 @@ include: fitness wearables, smart watches, and IoT wireless gateways.
threads/index.rst threads/index.rst
scheduling/index.rst scheduling/index.rst
other/interrupts.rst other/interrupts.rst
other/polling.rst
synchronization/semaphores.rst synchronization/semaphores.rst
synchronization/mutexes.rst synchronization/mutexes.rst
Data Passing
************
These pages cover kernel services which can be used to pass data between
threads and ISRs.
.. toctree::
:maxdepth: 2
data_passing/fifos.rst data_passing/fifos.rst
data_passing/lifos.rst data_passing/lifos.rst
data_passing/stacks.rst data_passing/stacks.rst
data_passing/message_queues.rst data_passing/message_queues.rst
data_passing/mailboxes.rst data_passing/mailboxes.rst
data_passing/pipes.rst data_passing/pipes.rst
timing/clocks.rst
other/cpu_idle.rst Memory Management
timing/timers.rst *****************
These pages cover memory allocation and management services.
.. toctree::
:maxdepth: 2
memory/slabs.rst memory/slabs.rst
memory/pools.rst memory/pools.rst
memory/heap.rst memory/heap.rst
Timing
******
These pages cover timing related services.
.. toctree::
:maxdepth: 2
timing/clocks.rst
timing/timers.rst
Other
*****
These pages cover other kernel services.
.. toctree::
:maxdepth: 2
other/cpu_idle.rst
other/atomic.rst other/atomic.rst
other/polling.rst
other/float.rst other/float.rst
other/ring_buffers.rst other/ring_buffers.rst
other/cxx_support.rst other/cxx_support.rst