diff options
Diffstat (limited to 'doc/ck_epoch_poll')
| -rw-r--r-- | doc/ck_epoch_poll | 7 |
1 files changed, 3 insertions, 4 deletions
diff --git a/doc/ck_epoch_poll b/doc/ck_epoch_poll index 68c4a4e..704b04a 100644 --- a/doc/ck_epoch_poll +++ b/doc/ck_epoch_poll @@ -47,10 +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 function will return true if at least one function was dispatched. -This function will return false if it has determined not all threads have -observed the latest generation of epoch-protected objects. Neither value -indicates an error. +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 |