diff --git a/doc/ck_pr_add b/doc/ck_pr_add index 44f3259..3fe2c19 100644 --- a/doc/ck_pr_add +++ b/doc/ck_pr_add @@ -54,7 +54,7 @@ Concurrency Kit (libck, \-lck) .Sh DESCRIPTION The .Fn ck_pr_add 3 -family of functions will atomically add the value specified by +family of functions atomically add the value specified by .Fa delta to the value pointed to by .Fa target . diff --git a/doc/ck_pr_and b/doc/ck_pr_and index 44d6395..4496149 100644 --- a/doc/ck_pr_and +++ b/doc/ck_pr_and @@ -52,7 +52,7 @@ Concurrency Kit (libck, \-lck) .Sh DESCRIPTION The .Fn ck_pr_and 3 -family of functions will atomically compute and store the +family of functions atomically compute and store the result of a bitwise-and of the value pointed to by .Fa target and diff --git a/doc/ck_pr_btc b/doc/ck_pr_btc index 49bf35d..55ced4a 100644 --- a/doc/ck_pr_btc +++ b/doc/ck_pr_btc @@ -48,14 +48,14 @@ Concurrency Kit (libck, \-lck) .Sh DESCRIPTION The .Fn ck_pr_btc 3 -family of functions will atomically fetch the value +family of functions atomically fetch the value of the bit in .Fa target at index .Fa bit_index and set that bit to its complement. .Sh RETURN VALUES -These family of functions will return the original value of +These family of functions return the original value of the bit at offset .Fa bit_index that is in the value pointed to by diff --git a/doc/ck_pr_btr b/doc/ck_pr_btr index 2bc44c0..fefa32a 100644 --- a/doc/ck_pr_btr +++ b/doc/ck_pr_btr @@ -48,14 +48,14 @@ Concurrency Kit (libck, \-lck) .Sh DESCRIPTION The .Fn ck_pr_btr 3 -family of functions will atomically fetch the value +family of functions atomically fetch the value of the bit in .Fa target at index .Fa bit_index and set that bit to 0. .Sh RETURN VALUES -These family of functions will return the original value of +This family of functions returns the original value of the bit at offset .Fa bit_index that is in the value pointed to by diff --git a/doc/ck_pr_bts b/doc/ck_pr_bts index dc50c32..7cf1a0a 100644 --- a/doc/ck_pr_bts +++ b/doc/ck_pr_bts @@ -48,14 +48,14 @@ Concurrency Kit (libck, \-lck) .Sh DESCRIPTION The .Fn ck_pr_bts 3 -family of functions will atomically fetch the value +family of functions atomically fetch the value of the bit in .Fa target at index .Fa bit_index and set that bit to 1. .Sh RETURN VALUES -These family of functions will return the original value of +This family of functions returns the original value of the bit at offset .Fa bit_index that is in the value pointed to by diff --git a/doc/ck_pr_cas b/doc/ck_pr_cas index 660d2d3..fe6fc3f 100644 --- a/doc/ck_pr_cas +++ b/doc/ck_pr_cas @@ -84,7 +84,7 @@ Concurrency Kit (libck, \-lck) .Sh DESCRIPTION The .Fn ck_pr_cas 3 -family of functions will atomically compare the value in +family of functions atomically compare the value in .Fa target for equality with .Fa old_value @@ -98,13 +98,13 @@ was not equal to the value specified by .Fa old_value then no modifications occur to the value in .Fa target . -The *_value form of these functions will unconditionally update +The *_value form of these functions unconditionally update .Fa original_value . .Sh RETURN VALUES -This family of functions will return true if the value in +This family of functions return true if the value in .Fa target was modified as a result of the operation. Otherwise, they -will return false. +return false. .Sh SEE ALSO .Xr ck_pr_fence_load 3 , .Xr ck_pr_fence_load_depends 3 , diff --git a/doc/ck_pr_dec b/doc/ck_pr_dec index f1a0659..2aa4375 100644 --- a/doc/ck_pr_dec +++ b/doc/ck_pr_dec @@ -72,12 +72,12 @@ Concurrency Kit (libck, \-lck) .Sh DESCRIPTION The .Fn ck_pr_dec 3 -family of functions will atomically decrement the value pointed to +family of functions atomically decrement the value pointed to by .Fa target . .Sh RETURN VALUES -The ck_pr_dec_zero family of functions will return true if the result -of the decrement operation was 0. They will return +The ck_pr_dec_zero family of functions returns true if the result +of the decrement operation was 0. They return false otherwise. .Sh SEE ALSO .Xr ck_pr_fence_load 3 , diff --git a/doc/ck_pr_faa b/doc/ck_pr_faa index 491eabc..9622a36 100644 --- a/doc/ck_pr_faa +++ b/doc/ck_pr_faa @@ -54,7 +54,7 @@ Concurrency Kit (libck, \-lck) .Sh DESCRIPTION The .Fn ck_pr_faa 3 -family of functions will atomically fetch the value pointed to +family of functions atomically fetch the value pointed to by .Fa target and add the value specified by @@ -62,7 +62,7 @@ and add the value specified by to the value pointed to by .Fa target . .Sh RETURN VALUES -This function will return the value pointed to by +This function returns the value pointed to by .Fa target at the time of operation invocation before the addition operation is applied. diff --git a/doc/ck_pr_fas b/doc/ck_pr_fas index 89d7f88..ce5e6f3 100644 --- a/doc/ck_pr_fas +++ b/doc/ck_pr_fas @@ -54,7 +54,7 @@ Concurrency Kit (libck, \-lck) .Sh DESCRIPTION The .Fn ck_pr_fas 3 -family of functions will atomically fetch the value pointed to +family of functions atomically fetch the value pointed to by .Fa target and replace the value pointed to by @@ -62,7 +62,7 @@ and replace the value pointed to by with the value specified by .Fa new_value . .Sh RETURN VALUES -This function will return the value pointed to by +This function returns the value pointed to by .Fa target at the time of operation invocation before it was atomically replaced with diff --git a/doc/ck_pr_fence_load b/doc/ck_pr_fence_load index 44431a1..97cb848 100644 --- a/doc/ck_pr_fence_load +++ b/doc/ck_pr_fence_load @@ -38,22 +38,22 @@ Concurrency Kit (libck, \-lck) .Ft void .Fn ck_pr_fence_strict_load void .Sh DESCRIPTION -This function will enforce the ordering of any memory load +This function enforces the ordering of any memory load and .Fn ck_pr_load 3 operations relative to the invocation of the function. Any store operations that were committed on remote processors and received by the calling processor before the invocation of .Fn ck_pr_fence_load -will also be made visible only after a call to +is also be made visible only after a call to .Fn ck_pr_fence_load . -This function will always serve as an implicit compiler barrier. +This function always serves as an implicit compiler barrier. On architectures with CK_MD_TSO or CK_MD_PSO specified (total store ordering -and partial store ordering respectively), this operation will only serve +and partial store ordering respectively), this operation only serves as a compiler barrier and no fence instructions will be emitted. To force the unconditional emission of a load fence, use .Fn ck_pr_fence_strict_load . -Architectures implementing CK_MD_RMO will always emit a load fence. +Architectures implementing CK_MD_RMO always emit a load fence. .Sh EXAMPLE .Bd -literal -offset indent diff --git a/doc/ck_pr_fence_memory b/doc/ck_pr_fence_memory index eab10ae..31eed57 100644 --- a/doc/ck_pr_fence_memory +++ b/doc/ck_pr_fence_memory @@ -40,13 +40,12 @@ Concurrency Kit (libck, \-lck) .Sh DESCRIPTION The .Fn ck_pr_fence_memory 3 -function will enforce the ordering of any memory operations +function enforces the ordering of any memory operations with respect to the invocation of the function. This function -will always serve as an implicit compiler barrier. -Achitectures implementing CK_MD_TSO will -only have this function serve as a compiler barrier and -no fence instructions will be emitted. Architectures -implementing CK_MD_PSO and CK_MD_RMO will always emit +always serves as an implicit compiler barrier. +Achitectures implementing CK_MD_TSO do not emit +a barrier, but compiler barrier semantics remain. +Architectures implementing CK_MD_PSO and CK_MD_RMO always emit an instructions which provides the specified ordering guarantees. To force the unconditional emission of a memory fence, use diff --git a/doc/ck_pr_fence_store b/doc/ck_pr_fence_store index 5bc0e6c..0fa573d 100644 --- a/doc/ck_pr_fence_store +++ b/doc/ck_pr_fence_store @@ -40,15 +40,15 @@ Concurrency Kit (libck, \-lck) .Sh DESCRIPTION The .Fn ck_pr_fence_store -function will enfore the ordering of any memory store, +function enfores the ordering of any memory store, .Fn ck_pr_store and atomic read-modify-write operations relative to -the invocation of the function. This function will +the invocation of the function. This function always serve as an implicit compiler barrier. On architectures implementing CK_MD_TSO, this operation -will only serve as a compiler barrier and no fences -will be emitted. On architectures implementing -CK_MD_PSO and CK_MD_RMO, a store fence will be +only serves as a compiler barrier and no fences +are emitted. On architectures implementing +CK_MD_PSO and CK_MD_RMO, a store fence is emitted. To force the unconditional emission of a store fence, use .Fn ck_pr_fence_strict_store . diff --git a/doc/ck_pr_inc b/doc/ck_pr_inc index b2d9cbd..fe2cb9e 100644 --- a/doc/ck_pr_inc +++ b/doc/ck_pr_inc @@ -72,12 +72,12 @@ Concurrency Kit (libck, \-lck) .Sh DESCRIPTION The .Fn ck_pr_inc 3 -family of functions will atomically increment the value pointed to +family of functions atomically increment the value pointed to by .Fa target . .Sh RETURN VALUES -The ck_pr_inc_zero family of functions will return true -if the result of the increment operation was 0. They will return +The ck_pr_inc_zero family of functions return true +if the result of the increment operation was 0. The functions return false otherwise. .Sh SEE ALSO .Xr ck_pr_fence_load 3 , diff --git a/doc/ck_pr_neg b/doc/ck_pr_neg index 9563e1e..fb441e8 100644 --- a/doc/ck_pr_neg +++ b/doc/ck_pr_neg @@ -72,12 +72,12 @@ Concurrency Kit (libck, \-lck) .Sh DESCRIPTION The .Fn ck_pr_neg 3 -family of functions will atomically negate the value pointed to +family of functions atomically negate the value pointed to by .Fa target . .Sh RETURN VALUES -The ck_pr_neg_zero family of functions will return true if the result -of the negation operation was 0. They will return false otherwise. +The ck_pr_neg_zero functions return true if the result +of the negation operation was 0. They return false otherwise. .Sh SEE ALSO .Xr ck_pr_fence_load 3 , .Xr ck_pr_fence_load_depends 3 , diff --git a/doc/ck_pr_not b/doc/ck_pr_not index ed776ca..0847bf6 100644 --- a/doc/ck_pr_not +++ b/doc/ck_pr_not @@ -54,7 +54,7 @@ Concurrency Kit (libck, \-lck) .Sh DESCRIPTION The .Fn ck_pr_not 3 -family of functions will atomically complement the value pointed to +family of functions atomically complement the value pointed to by .Fa target . .Sh RETURN VALUES diff --git a/doc/ck_pr_or b/doc/ck_pr_or index c5ff055..dfb4a1e 100644 --- a/doc/ck_pr_or +++ b/doc/ck_pr_or @@ -52,7 +52,7 @@ Concurrency Kit (libck, \-lck) .Sh DESCRIPTION The .Fn ck_pr_or 3 -family of functions will atomically compute and store the +family of functions atomically compute and store the result of a bitwise-or of the value pointed to by .Fa target and diff --git a/doc/ck_pr_sub b/doc/ck_pr_sub index c33f65d..df03031 100644 --- a/doc/ck_pr_sub +++ b/doc/ck_pr_sub @@ -54,7 +54,7 @@ Concurrency Kit (libck, \-lck) .Sh DESCRIPTION The .Fn ck_pr_sub 3 -family of functions will atomically subtract the value specified by +family of functions atomically subtract the value specified by .Fa delta from the value pointed to by .Fa target . diff --git a/doc/ck_pr_xor b/doc/ck_pr_xor index 9b0dcb5..e3c1db8 100644 --- a/doc/ck_pr_xor +++ b/doc/ck_pr_xor @@ -52,7 +52,7 @@ Concurrency Kit (libck, \-lck) .Sh DESCRIPTION The .Fn ck_pr_xor 3 -family of functions will atomically compute and store the +family of functions atomically compute and store the result of a bitwise-xor of the value pointed to by .Fa target and