Skip to content

Commit e9c858a

Browse files
mbolivar-nordicioannisg
authored andcommitted
doc: split kernel reference toctrees
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 <[email protected]>
1 parent 613655e commit e9c858a

File tree

1 file changed

+46
-4
lines changed

1 file changed

+46
-4
lines changed

doc/reference/kernel/index.rst

Lines changed: 46 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,29 +21,71 @@ devices (like Wi-Fi and Bluetooth Low Energy), and complex multi-threading,
2121
can also be developed using the Zephyr kernel. Examples of such systems
2222
include: fitness wearables, smart watches, and IoT wireless gateways.
2323

24+
Scheduling, Interrupts, and Synchronization
25+
*******************************************
26+
27+
These pages cover basic kernel services related to thread scheduling and
28+
synchronization.
2429

2530
.. toctree::
2631
:maxdepth: 2
2732

2833
threads/index.rst
2934
scheduling/index.rst
3035
other/interrupts.rst
36+
other/polling.rst
3137
synchronization/semaphores.rst
3238
synchronization/mutexes.rst
39+
40+
Data Passing
41+
************
42+
43+
These pages cover kernel services which can be used to pass data between
44+
threads and ISRs.
45+
46+
.. toctree::
47+
:maxdepth: 2
48+
3349
data_passing/fifos.rst
3450
data_passing/lifos.rst
3551
data_passing/stacks.rst
3652
data_passing/message_queues.rst
3753
data_passing/mailboxes.rst
3854
data_passing/pipes.rst
39-
timing/clocks.rst
40-
other/cpu_idle.rst
41-
timing/timers.rst
55+
56+
Memory Management
57+
*****************
58+
59+
These pages cover memory allocation and management services.
60+
61+
.. toctree::
62+
:maxdepth: 2
63+
4264
memory/slabs.rst
4365
memory/pools.rst
4466
memory/heap.rst
67+
68+
Timing
69+
******
70+
71+
These pages cover timing related services.
72+
73+
.. toctree::
74+
:maxdepth: 2
75+
76+
timing/clocks.rst
77+
timing/timers.rst
78+
79+
Other
80+
*****
81+
82+
These pages cover other kernel services.
83+
84+
.. toctree::
85+
:maxdepth: 2
86+
87+
other/cpu_idle.rst
4588
other/atomic.rst
46-
other/polling.rst
4789
other/float.rst
4890
other/ring_buffers.rst
4991
other/cxx_support.rst

0 commit comments

Comments
 (0)