From: Carlos Bilbao <carlos.bilbao@xxxxxxxxxx>
Fix circular buffer usage in producer/consumer examples in
circular-buffers.rst. They incorrectly access items using buffer[head] and
buffer[tail], as if buffer was a flat array; but the examples also use
buffer->head and buffer->tail, so it's a struct. Use buffer->vals[head] and
buffer->vals[tail] instead to match the intended layout.
Signed-off-by: Carlos Bilbao <carlos.bilbao@xxxxxxxxxx>
---
Documentation/core-api/circular-buffers.rst | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/Documentation/core-api/circular-buffers.rst b/Documentation/core-api/circular-buffers.rst
index 50966f66e398..b697915a2bd0 100644
--- a/Documentation/core-api/circular-buffers.rst
+++ b/Documentation/core-api/circular-buffers.rst
@@ -161,7 +161,7 @@ The producer will look something like this::
if (CIRC_SPACE(head, tail, buffer->size) >= 1) {
/* insert one item into the buffer */
- struct item *item = buffer[head];
+ struct item *item = buffer->vals[head];
produce_item(item);
@@ -203,7 +203,7 @@ The consumer will look something like this::
if (CIRC_CNT(head, tail, buffer->size) >= 1) {
/* extract one item from the buffer */
- struct item *item = buffer[tail];
+ struct item *item = buffer->vals[tail];
consume_item(item);
--
2.43.0
