[DOC] xQueueOverwrite Queue Length

[schilkp]

Describe the issue

The documentation for xQueueOverwrite states:

xQueueOverwrite() is intended for use with queues that have a length of one, 
meaning the queue is either empty or full.

xQueueOverwrite calls xQueueGenericSend:

#define xQueueOverwrite( xQueue, pvItemToQueue ) \
    xQueueGenericSend( ( xQueue ), ( pvItemToQueue ), 0, queueOVERWRITE )

xQueueGenericSend features the following assertion:

configASSERT( !( ( xCopyPosition == queueOVERWRITE ) && ( pxQueue->uxLength != 1 ) ) );

This means that either:

• xQueueOverwrite is not just intended for queues of length one, but requires queues of length one.
• The assertion in xQueueGenericSend is overly conservative.

Reference https://www.freertos.org/xQueueOverwrite.html

Browser

• Browser: [e.g. Chrome]
• Version: [e.g. 80.0.3987.132]

Thanks!

[kar-rahul-aws]

Hi @schilkp Thank you for reporting the issue. We will fix the documentation and update.

[kar-rahul-aws]

Hi @schilkp It has been updated in the website. Closing the issue.