From b9ac9fadde035f221f88dc93dc8c469c7f283340 Mon Sep 17 00:00:00 2001 From: Inaky Perez-Gonzalez Date: Mon, 13 Jun 2016 11:41:02 -0700 Subject: [PATCH] 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 --- doc/kernel/microkernel/microkernel_pipes.rst | 5 ++++- doc/kernel/nanokernel/nanokernel_fibers.rst | 10 ++++++++-- doc/kernel/nanokernel/nanokernel_fifos.rst | 7 +++++-- doc/kernel/nanokernel/nanokernel_lifos.rst | 7 +++++-- doc/kernel/nanokernel/nanokernel_stacks.rst | 3 +++ doc/kernel/nanokernel/nanokernel_synchronization.rst | 3 +++ doc/kernel/nanokernel/nanokernel_timers.rst | 5 +++++ 7 files changed, 33 insertions(+), 7 deletions(-) diff --git a/doc/kernel/microkernel/microkernel_pipes.rst b/doc/kernel/microkernel/microkernel_pipes.rst index 10a802cc042..944ffa4e86a 100644 --- a/doc/kernel/microkernel/microkernel_pipes.rst +++ b/doc/kernel/microkernel/microkernel_pipes.rst @@ -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. diff --git a/doc/kernel/nanokernel/nanokernel_fibers.rst b/doc/kernel/nanokernel/nanokernel_fibers.rst index 7bc95b95a64..1b717b05657 100644 --- a/doc/kernel/nanokernel/nanokernel_fibers.rst +++ b/doc/kernel/nanokernel/nanokernel_fibers.rst @@ -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. diff --git a/doc/kernel/nanokernel/nanokernel_fifos.rst b/doc/kernel/nanokernel/nanokernel_fifos.rst index cd6cbd93e86..b8ccbf5d5b3 100644 --- a/doc/kernel/nanokernel/nanokernel_fifos.rst +++ b/doc/kernel/nanokernel/nanokernel_fifos.rst @@ -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. diff --git a/doc/kernel/nanokernel/nanokernel_lifos.rst b/doc/kernel/nanokernel/nanokernel_lifos.rst index dc7f7f493fb..b7dc7de7f33 100644 --- a/doc/kernel/nanokernel/nanokernel_lifos.rst +++ b/doc/kernel/nanokernel/nanokernel_lifos.rst @@ -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. diff --git a/doc/kernel/nanokernel/nanokernel_stacks.rst b/doc/kernel/nanokernel/nanokernel_stacks.rst index ec85ee100db..7f9f6e09e5e 100644 --- a/doc/kernel/nanokernel/nanokernel_stacks.rst +++ b/doc/kernel/nanokernel/nanokernel_stacks.rst @@ -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. diff --git a/doc/kernel/nanokernel/nanokernel_synchronization.rst b/doc/kernel/nanokernel/nanokernel_synchronization.rst index b5b3da32730..954977471a4 100644 --- a/doc/kernel/nanokernel/nanokernel_synchronization.rst +++ b/doc/kernel/nanokernel/nanokernel_synchronization.rst @@ -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. diff --git a/doc/kernel/nanokernel/nanokernel_timers.rst b/doc/kernel/nanokernel/nanokernel_timers.rst index 4e0d0d91a08..8d8658b3bd6 100644 --- a/doc/kernel/nanokernel/nanokernel_timers.rst +++ b/doc/kernel/nanokernel/nanokernel_timers.rst @@ -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.