Commit 26d2c128 authored by Archie Atkinson's avatar Archie Atkinson Committed by Carles Cufi
Browse files

doc: fixes errors pipes wiki entry

Moves the 'Flushing a Pipe' code example to the correct location
and section and re-adds the 'Suggested Uses' text missing
compared to v2.7.

Signed-off-by: default avatarArchie Atkinson <archie.atkinson@chiaro.co.uk>
parent 6a9243c1
Loading
Loading
Loading
Loading
+10 −3
Changes for doc/kernel/services/data_passing/pipes.rst: 10 added lines, 3 removed lines.
Original line number Diff line number Diff line
@@ -200,9 +200,6 @@ All data in the pipe is flushed by calling :c:func:`k_pipe_flush`.
The following code builds on the examples above, and flushes all the
data in the pipe.

Suggested uses
**************

.. code-block:: c

    void monitor_thread(void)
@@ -215,6 +212,16 @@ Suggested uses
        }
    }


Suggested uses
**************

Use a pipe to send streams of data between threads.

.. note::
    A pipe can be used to transfer long streams of data if desired. However it is often preferable to send pointers to large data items to avoid copying the data.


Configuration Options
*********************