Commit 8ec1a279 authored by Benjamin Cabé's avatar Benjamin Cabé Committed by Johan Hedberg
Browse files

doc: ring_buffer: fix typos and incoherences 

Fixed an incorrect mention of buffer size being expressed in 32-byte
words for data item mode when it's in fact 32-bit.
Fixed a few broken references to C functions and structs.

Signed-off-by: default avatarBenjamin Cabé <benjamin@zephyrproject.org>
parent 14c1ff25

doc/kernel/data_structures/ring_buffers.rst

+2 −2
Changes for doc/kernel/data_structures/ring_buffers.rst: 2 added lines, 2 removed lines.
Original line number Diff line number Diff line
@@ -44,7 +44,7 @@ A ring buffer has the following key properties: 
  bytes or 32-bit words that have been added to the ring buffer but not yet

  removed.



* A **data buffer size**, measured in bytes or 32-byte words. This governs

* A **data buffer size**, measured in bytes or 32-bit words. This governs

  the maximum amount of data (including possible metadata values) the ring

  buffer can hold.
@@ -53,7 +53,7 @@ data buffer to empty. 


A ``struct ring_buf`` may be placed anywhere in user-accessible

memory, and must be initialized with :c:func:`ring_buf_init` or

:c:func:`ring_buf_element_init` before use. This must be provided a region

:c:func:`ring_buf_item_init` before use. This must be provided a region

of user-controlled memory for use as the buffer itself.  Note carefully that the units of the size of the

buffer passed change (either bytes or words) depending on how the ring

buffer will be used later.  Macros for combining these steps in a

CRA Git | Maintained and supported by SUSTech CRA and CCSE