doc/ck_ring_capacity: Additional clarifications.

Thanks to mhaberler.
9 years ago · fcd2af0884
parent 5e41c10d82
commit fcd2af0884
1 changed files with 3 additions and 0 deletions
--- 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 ,