Merge branch 'docs/Specify_two_calls_to_RingbufferReceive_is_required_in_wrap_mode' into 'master'

Add a note to specify that two calls to RingbufferReceive are required in wrap mode

Closes IDF-1980

See merge request espressif/esp-idf!9999

Author: krzychb

components/esp_ringbuf/include/freertos/ringbuf.h

@@ -255,6 +255,7 @@ void *xRingbufferReceive(RingbufHandle_t xRingbuffer, size_t *pxItemSize, TickTy
  *
  * @note    A call to vRingbufferReturnItemFromISR() is required after this to free the item retrieved.
  * @note    Byte buffers do not allow multiple retrievals before returning an item
+ * @note    Two calls to RingbufferReceiveFromISR() are required if the bytes wrap around the end of the ring buffer.
  *
  * @return
  *      - Pointer to the retrieved item on success; *pxItemSize filled with the length of the item.
@@ -333,6 +334,7 @@ BaseType_t xRingbufferReceiveSplitFromISR(RingbufHandle_t xRingbuffer,
  * @note    A call to vRingbufferReturnItem() is required after this to free up the data retrieved.
  * @note    This function should only be called on byte buffers
  * @note    Byte buffers do not allow multiple retrievals before returning an item
+ * @note    Two calls to RingbufferReceiveUpTo() are required if the bytes wrap around the end of the ring buffer.
  *
  * @return
  *      - Pointer to the retrieved item on success; *pxItemSize filled with

docs/en/api-reference/system/freertos_additions.rst

@@ -210,6 +210,9 @@ using :cpp:func:`xRingbufferReceiveUpTo` and :cpp:func:`vRingbufferReturnItem`
 For ISR safe versions of the functions used above, call :cpp:func:`xRingbufferSendFromISR`, :cpp:func:`xRingbufferReceiveFromISR`,
 :cpp:func:`xRingbufferReceiveSplitFromISR`, :cpp:func:`xRingbufferReceiveUpToFromISR`, and :cpp:func:`vRingbufferReturnItemFromISR`
 
+.. note::
+
+    Two calls to RingbufferReceive[UpTo][FromISR]() are required if the bytes wraps around the end of the ring buffer.
 
 Sending to Ring Buffer
 ^^^^^^^^^^^^^^^^^^^^^^