doc/ck_pr: Passive voice fixes.

ck_pring
Samy Al Bahra 12 years ago
parent 57e96b00ed
commit b8d0ec526f

@ -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 .

@ -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

@ -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

@ -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

@ -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

@ -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 ,

@ -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 ,

@ -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.

@ -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

@ -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

@ -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

@ -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 .

@ -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 ,

@ -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 ,

@ -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

@ -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

@ -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 .

@ -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

Loading…
Cancel
Save