From fcd2af088467153e27c49ec4160cdd778b8ea9c4 Mon Sep 17 00:00:00 2001
From: Samy Al Bahra <sbahra@backtrace.io>
Date: Mon, 14 Sep 2015 14:52:45 -0400
Subject: [PATCH] doc/ck_ring_capacity: Additional clarifications.

Thanks to mhaberler.
---
 doc/ck_ring_capacity | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/doc/ck_ring_capacity b/doc/ck_ring_capacity
index 0332433..645b54b 100644
--- a/doc/ck_ring_capacity
+++ b/doc/ck_ring_capacity
@@ -41,6 +41,9 @@ The
 function returns the number of pointers that can be
 held in the buffer pointed to by
 .Fa ring .
+Note that a ring can only hold
+.Fn ck_ring_capacity 3
+minus one entries at a time.
 .Sh SEE ALSO
 .Xr ck_ring_init 3 ,
 .Xr ck_ring_enqueue_spmc 3 ,