doc: fix 'unexpected indentation' warnings
Add a blank line in most places is the fix needed, to have the formatting engine recognize it properly. Change-Id: Iccaa0e51146b1e2c138e89ab1dd0067fc1409e4d Signed-off-by: Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
This commit is contained in:
parent
0d2593b782
commit
b9ac9fadde
7 changed files with 33 additions and 7 deletions
|
@ -15,8 +15,11 @@ but not yet received; alternatively, the pipe may have no ring buffer.
|
|||
Pipes can be used to transfer chunks of data in whole or in part, and either
|
||||
synchronously or asynchronously.
|
||||
|
||||
Any number of pipes can be defined in a microkernel system. Each pipe needs
|
||||
Any number of pipes can be defined in a microkernel system. Each pipe
|
||||
needs
|
||||
|
||||
* A **name** to uniquely identify it.
|
||||
|
||||
* A **size**, in bytes, of the ring buffer. Note that a size of zero defines
|
||||
a pipe with no ring buffer.
|
||||
|
||||
|
|
|
@ -281,27 +281,33 @@ APIs affecting the currently-executing fiber are provided
|
|||
by :file:`microkernel.h` and by :file:`nanokernel.h`:
|
||||
|
||||
:cpp:func:`fiber_yield()`
|
||||
|
||||
Yield the CPU to higher priority and equal priority fibers.
|
||||
|
||||
:cpp:func:`fiber_sleep()`
|
||||
|
||||
Yield the CPU for a specified time period.
|
||||
|
||||
:cpp:func:`fiber_abort()`
|
||||
|
||||
Terminate fiber execution.
|
||||
|
||||
APIs affecting a specified fiber are provided by
|
||||
:file:`microkernel.h` and by :file:`nanokernel.h`:
|
||||
APIs affecting a specified fiber are provided by :file:`microkernel.h`
|
||||
and by :file:`nanokernel.h`:
|
||||
|
||||
:cpp:func:`task_fiber_start()`, :cpp:func:`fiber_fiber_start()`,
|
||||
:cpp:func:`fiber_start()`
|
||||
|
||||
Spawn a new fiber.
|
||||
|
||||
:cpp:func:`task_fiber_delayed_start()`,
|
||||
:cpp:func:`fiber_fiber_delayed_start()`,
|
||||
:cpp:func:`fiber_delayed_start()`
|
||||
|
||||
Spawn a new fiber after a specified time period.
|
||||
|
||||
:cpp:func:`task_fiber_delayed_start_cancel()`,
|
||||
:cpp:func:`fiber_fiber_delayed_start_cancel()`,
|
||||
:cpp:func:`fiber_delayed_start_cancel()`
|
||||
|
||||
Cancel spawning of a new fiber, if not already started.
|
||||
|
|
|
@ -129,13 +129,16 @@ APIs
|
|||
The following APIs for a nanokernel FIFO are provided by :file:`nanokernel.h`:
|
||||
|
||||
:cpp:func:`nano_fifo_init()`
|
||||
|
||||
Initializes a FIFO.
|
||||
|
||||
:cpp:func:`nano_task_fifo_put()`, :cpp:func:`nano_fiber_fifo_put()`,
|
||||
:cpp:func:`nano_isr_fifo_put()`, :cpp:func:`nano_fifo_put()`
|
||||
|
||||
Add an item to a FIFO.
|
||||
|
||||
:cpp:func:`nano_task_fifo_get()`, :cpp:func:`nano_fiber_fifo_get()`,
|
||||
:cpp:func:`nano_isr_fifo_get()`, :cpp:func:`nano_fifo_get()`
|
||||
Remove an item from a FIFO, or waits for an item for a specified time
|
||||
period if it is empty.
|
||||
|
||||
Remove an item from a FIFO, or waits for an item for a specified
|
||||
time period if it is empty.
|
||||
|
|
|
@ -127,13 +127,16 @@ APIs
|
|||
The following APIs for a nanokernel LIFO are provided by :file:`nanokernel.h`:
|
||||
|
||||
:cpp:func:`nano_lifo_init()`
|
||||
|
||||
Initializes a LIFO.
|
||||
|
||||
:cpp:func:`nano_task_lifo_put()`, :cpp:func:`nano_fiber_lifo_put()`,
|
||||
:cpp:func:`nano_isr_lifo_put()`, :cpp:func:`nano_lifo_put()`
|
||||
|
||||
Add an item to a LIFO.
|
||||
|
||||
:cpp:func:`nano_task_lifo_get()`, :cpp:func:`nano_fiber_lifo_get()`,
|
||||
:cpp:func:`nano_isr_lifo_get()`, :cpp:func:`nano_lifo_get()`
|
||||
Remove an item from a LIFO, or waits for an item for a specified time
|
||||
period if it is empty.
|
||||
|
||||
Remove an item from a LIFO, or waits for an item for a specified
|
||||
time period if it is empty.
|
||||
|
|
|
@ -128,12 +128,15 @@ The following APIs for a nanokernel stack are provided by
|
|||
:file:`nanokernel.h`:
|
||||
|
||||
:cpp:func:`nano_stack_init()`
|
||||
|
||||
Initializes a stack.
|
||||
|
||||
:cpp:func:`nano_task_stack_push()`, :cpp:func:`nano_fiber_stack_push()`,
|
||||
:cpp:func:`nano_isr_stack_push()`, :cpp:func:`nano_stack_push()`
|
||||
|
||||
Add an item to a stack.
|
||||
|
||||
:cpp:func:`nano_task_stack_pop()`, :cpp:func:`nano_fiber_stack_pop()`,
|
||||
:cpp:func:`nano_isr_stack_pop()`, :cpp:func:`nano_stack_pop()`
|
||||
|
||||
Remove an item from a stack, or wait for an item if it is empty.
|
||||
|
|
|
@ -119,12 +119,15 @@ The following APIs for a nanokernel semaphore are provided
|
|||
by :file:`nanokernel.h`:
|
||||
|
||||
:cpp:func:`nano_sem_init()`
|
||||
|
||||
Initialize a semaphore.
|
||||
|
||||
:cpp:func:`nano_task_sem_give()`, :cpp:func:`nano_fiber_sem_give()`,
|
||||
:cpp:func:`nano_isr_sem_give()`, :cpp:func:`nano_sem_give()`
|
||||
|
||||
Signal a sempahore.
|
||||
|
||||
:cpp:func:`nano_task_sem_take()`, :cpp:func:`nano_fiber_sem_take()`,
|
||||
:cpp:func:`nano_isr_sem_take()`, :cpp:func:`nano_sem_take()`
|
||||
|
||||
Wait on a semaphore for a specified time period.
|
||||
|
|
|
@ -156,19 +156,24 @@ APIs for a nanokernel timer provided by :file:`nanokernel.h`
|
|||
============================================================
|
||||
|
||||
:cpp:func:`nano_timer_init()`
|
||||
|
||||
Initialize a timer.
|
||||
|
||||
:cpp:func:`nano_task_timer_start()`, :cpp:func:`nano_fiber_timer_start()`,
|
||||
:cpp:func:`nano_isr_timer_start()`, :cpp:func:`nano_timer_start()`
|
||||
|
||||
Start a timer.
|
||||
|
||||
:cpp:func:`nano_task_timer_test()`, :cpp:func:`nano_fiber_timer_test()`,
|
||||
:cpp:func:`nano_isr_timer_test()`, :cpp:func:`nano_timer_test()`
|
||||
|
||||
Wait or test for timer expiration.
|
||||
|
||||
:cpp:func:`nano_task_timer_stop()`, :cpp:func:`nano_fiber_timer_stop()`,
|
||||
:cpp:func:`nano_isr_timer_stop()`, :cpp:func:`nano_timer_stop()`
|
||||
|
||||
Force timer expiration, if not already expired.
|
||||
|
||||
:cpp:func:`nano_timer_ticks_remain()`
|
||||
|
||||
Return timer ticks before timer expiration.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue