X-Git-Url: http://git.lttng.org/?p=userspace-rcu.git;a=blobdiff_plain;f=doc%2Fcds-api.md;fp=doc%2Fcds-api.md;h=3d313b78e9d41cc5a40f8f381a244c4b864d6867;hp=5bc615ea42ff9ce8deea1e4e0d65b8abea07e942;hb=ed4c6ca597ff4211e1379a650403836fd59e9368;hpb=8c677380d0f9241b9cd548082cf843c5111736d8 diff --git a/doc/cds-api.md b/doc/cds-api.md index 5bc615e..3d313b7 100644 --- a/doc/cds-api.md +++ b/doc/cds-api.md @@ -33,12 +33,12 @@ Downside over `list.h`: lookup of tail in O(n). Doubly-linked list, with single pointer list head. Requires mutual exclusion on updates, allows RCU read traversals. Useful -for implementing hash tables. Downside over rculist.h: lookup of tail in O(n). +for implementing hash tables. Downside over `rculist.h`: lookup of tail in O(n). ### `urcu/wfstack.h` -Stack with wait-free push and wait-free pop_all. Both +Stack with wait-free push and wait-free pop\_all. Both blocking and non-blocking pop and traversal operations are provided. This stack does _not_ specifically rely on RCU. Various synchronization techniques can be used to deal with pop ABA. Those are detailed in the API. @@ -59,7 +59,7 @@ traversal (see API for details). ### `urcu/lfstack.h` -Stack with lock-free push, lock-free pop, wait-free pop_all, +Stack with lock-free push, lock-free pop, wait-free pop\_all, wait-free traversal. Various synchronization techniques can be used to deal with pop ABA. Those are detailed in the API. This stack does _not_ specifically rely on RCU.