Skip to content

Commit bc3f1d8

Browse files
committed
doc: libraries: bm_scheduler: update documentation
Updates to the documentation, call the library "Bare Metal scheduler". Signed-off-by: Emanuele Di Santo <[email protected]>
1 parent 1f6817c commit bc3f1d8

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

doc/nrf-bm/libraries/bm_scheduler.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
.. _lib_bm_scheduler:
22

3-
Event Scheduler
4-
###############
3+
Bare Metal scheduler
4+
####################
55

66
.. contents::
77
:local:
88
:depth: 2
99

10-
The event scheduler is used for transferring execution from the interrupt context to the main application context.
10+
The Bare Metal scheduler is a library for scheduling functions to run on the main thread.
1111

1212
Overview
1313
********
1414

15-
In some applications, it is beneficial to defer the execution of certain interrupts, such as those from the SoftDevice, to the main application function.
15+
This library enables queuing and execution of functions in the main-thread context.
16+
It can be used, for example, to defer the execution of operations from an ISR to the main thread.
1617
This shortens the time spent in the interrupt service routine (ISR).
17-
It also allows for lower priority events to be raised before the previous event is fully processed.
1818

1919
Configuration
2020
*************
@@ -34,7 +34,7 @@ Usage
3434

3535
The SoftDevice event handler can call the :c:func:`bm_scheduler_defer` function to schedule an event for later execution in the main thread.
3636

37-
To process these deferred events, call the :c:func:`bm_scheduler_process` function regularly in the main application function.
37+
To process these deferred events, call the :c:func:`bm_scheduler_process` function regularly in the main application loop.
3838

3939
Dependencies
4040
************
@@ -47,4 +47,4 @@ API documentation
4747
| Header file: :file:`include/bm/bm_scheduler.h`
4848
| Source files: :file:`lib/bm_scheduler/`
4949
50-
:ref:`Event Scheduler library API reference <api_bm_scheduler>`
50+
:ref:`Bare Metal scheduler library API reference <api_bm_scheduler>`

0 commit comments

Comments
 (0)