]> granicus.if.org Git - esp-idf/commit
ringbuf: Fixes to header files for better understanding
authorPiyush Shah <piyush@espressif.com>
Fri, 17 Nov 2017 10:20:49 +0000 (15:50 +0530)
committerPiyush Shah <piyush@espressif.com>
Tue, 21 Nov 2017 11:46:04 +0000 (17:16 +0530)
commit7dd9c4f57fb89e2abeebf7fdbf938f7532e955b5
treedb83c872c3656bd28b5b329930384946abd15fdd
parent62f44e45df111fcfcc68e9a56bbfb562d2246154
ringbuf: Fixes to header files for better understanding

1. Usage of this module required applications to include additional
files. What files to include is not very intuitive. Instead, it is
better for the header file itself to include other files as required.
2. Even though it may seem logical, it is better to explicitly mention
that an item needs to be "Returned" after a Receive

Signed-off-by: Piyush Shah <piyush@espressif.com>
components/freertos/include/freertos/ringbuf.h