summaryrefslogtreecommitdiffstats
path: root/doc/ck_epoch_poll
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2021-07-23 11:29:01 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2021-07-23 11:37:28 +0000
commita7283ab143d4e95e8f5f22b58c61cb4e2f604749 (patch)
tree3ec5165ac7f1299f5c0dc3e41d7560a06e6267f5 /doc/ck_epoch_poll
parentAdding debian version 0.6.0-2. (diff)
downloadck-a7283ab143d4e95e8f5f22b58c61cb4e2f604749.tar.xz
ck-a7283ab143d4e95e8f5f22b58c61cb4e2f604749.zip
Merging upstream version 0.7.1 (Closes: #991419).
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/ck_epoch_poll')
-rw-r--r--doc/ck_epoch_poll7
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