From 853c692bdb7a8182c9f4af26e5fe49ce453061f4 Mon Sep 17 00:00:00 2001 From: Samy Al Bahra Date: Sat, 13 Oct 2018 23:01:56 -0400 Subject: [PATCH] doc/ck_epoch_poll: clarify language around return value. --- doc/ck_epoch_poll | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/ck_epoch_poll b/doc/ck_epoch_poll index b1b1f79..704b04a 100644 --- a/doc/ck_epoch_poll +++ b/doc/ck_epoch_poll @@ -47,9 +47,9 @@ if deemed safe. This function is meant to be used in cases epoch reclamation cost must be amortized over time in a manner that does not affect caller progress. .Sh RETURN VALUES -This functions returns false if no memory was reclaimed, the records -are not in a grace period or if no forward progress was made to the -counter. +This functions returns false if the following conditions are met: +no memory was reclaimed, the records are not in a grace period and no forward +progress was made. .Sh ERRORS Behavior is undefined if the object pointed to by .Fa record