rte_ring: remove leftover comment about watermark

Message ID 20220531172041.132503-1-stephen@networkplumber.org (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series rte_ring: remove leftover comment about watermark |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation fail Compilation issues
ci/intel-Testing success Testing PASS
ci/github-robot: build fail github build: failed
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-x86_64-compile-testing success Testing PASS
ci/iol-x86_64-unit-testing success Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-aarch64-unit-testing success Testing PASS
ci/iol-aarch64-compile-testing success Testing PASS
ci/iol-abi-testing success Testing PASS

Commit Message

Stephen Hemminger May 31, 2022, 5:20 p.m. UTC
  The watermark support was removed from rte_ring since version
17.02 but there is leftover in comments.

Fixes: 77dd3064270c ("ring: remove watermark support")
Cc: bruce.richardson@intel.com
Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
---
 lib/ring/rte_ring.h | 14 ++++++--------
 1 file changed, 6 insertions(+), 8 deletions(-)
  

Comments

Thomas Monjalon Nov. 15, 2022, 4:44 p.m. UTC | #1
31/05/2022 19:20, Stephen Hemminger:
> The watermark support was removed from rte_ring since version
> 17.02 but there is leftover in comments.
> 
> Fixes: 77dd3064270c ("ring: remove watermark support")
> Cc: bruce.richardson@intel.com
> Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>

Applied, thanks.
  

Patch

diff --git a/lib/ring/rte_ring.h b/lib/ring/rte_ring.h
index 980e92e59493..4bf8e16baa23 100644
--- a/lib/ring/rte_ring.h
+++ b/lib/ring/rte_ring.h
@@ -66,10 +66,9 @@  ssize_t rte_ring_get_memsize(unsigned int count);
  * object table. It is advised to use rte_ring_get_memsize() to get the
  * appropriate size.
  *
- * The ring size is set to *count*, which must be a power of two. Water
- * marking is disabled by default. The real usable ring size is
- * *count-1* instead of *count* to differentiate a full ring from an
- * empty ring.
+ * The ring size is set to *count*, which must be a power of two.
+ * The real usable ring size is *count-1* instead of *count* to
+ * differentiate a full ring from an empty ring.
  *
  * The ring is not added in RTE_TAILQ_RING global list. Indeed, the
  * memory given by the caller may not be shareable among dpdk
@@ -127,10 +126,9 @@  int rte_ring_init(struct rte_ring *r, const char *name, unsigned int count,
  * This function uses ``memzone_reserve()`` to allocate memory. Then it
  * calls rte_ring_init() to initialize an empty ring.
  *
- * The new ring size is set to *count*, which must be a power of
- * two. Water marking is disabled by default. The real usable ring size
- * is *count-1* instead of *count* to differentiate a full ring from an
- * empty ring.
+ * The new ring size is set to *count*, which must be a power of two.
+ * The real usable ring size is *count-1* instead of *count* to
+ * differentiate a full ring from an empty ring.
  *
  * The ring is added in RTE_TAILQ_RING list.
  *