From 2aa12479981a9bb43034bb3ccb7022ff865ebb2b Mon Sep 17 00:00:00 2001 From: Krzysztof Chruscinski Date: Tue, 10 Aug 2021 10:47:09 +0200 Subject: [PATCH] lib: os: ring_buffer: Clarify macro description Description was falsely static that macros statically creates the ring buffer objects. Clarify description since variables are not static. Signed-off-by: Krzysztof Chruscinski --- include/sys/ring_buffer.h | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/include/sys/ring_buffer.h b/include/sys/ring_buffer.h index 58b29217f1b..2888e67e123 100644 --- a/include/sys/ring_buffer.h +++ b/include/sys/ring_buffer.h @@ -64,7 +64,7 @@ struct ring_buf { */ /** - * @brief Statically define and initialize a high performance ring buffer. + * @brief Define and initialize a high performance ring buffer. * * This macro establishes a ring buffer whose size must be a power of 2; * that is, the ring buffer contains 2^pow 32-bit words, where @a pow is @@ -90,7 +90,7 @@ struct ring_buf { } /** - * @brief Statically define and initialize a standard ring buffer. + * @brief Define and initialize a standard ring buffer. * * This macro establishes a ring buffer of an arbitrary size. A standard * ring buffer uses modulo arithmetic operations to maintain itself. @@ -113,7 +113,7 @@ struct ring_buf { } /** - * @brief Statically define and initialize a ring buffer for byte data. + * @brief Define and initialize a ring buffer for byte data. * * This macro establishes a ring buffer of an arbitrary size. *