futex.2: Rename 'op' argument to 'futex_op'

This is a little more readable, and also helps avoid confusing
when talking about the 'op' subfield in the FUTEX_WAKE_OP
discussion.

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
This commit is contained in:
Michael Kerrisk 2015-01-12 15:40:43 +01:00
parent 9a12ca2185
commit d33602c4e0
1 changed files with 8 additions and 9 deletions

View File

@ -59,9 +59,8 @@ futex \- fast user-space locking
.B "#include <linux/futex.h>" .B "#include <linux/futex.h>"
.B "#include <sys/time.h>" .B "#include <sys/time.h>"
.sp .sp
.BI "int futex(int *" uaddr ", int " op ", int " val \ .BI "int futex(int *" uaddr ", int " futex_op ", int " val ,
", const struct timespec *" timeout , .BI " const struct timespec *" timeout ,
.br
.BI " int *" uaddr2 ", int " val3 ); .BI " int *" uaddr2 ", int " val3 );
.\" int *? void *? u32 *? .\" int *? void *? u32 *?
.fi .fi
@ -108,13 +107,13 @@ argument, along with a value
.IR val . .IR val .
.PP .PP
The The
.I op .I futex_op
argument consists of two parts: argument consists of two parts:
a command that specifies the operation to be performed, a command that specifies the operation to be performed,
bit-wise ORed with zero or or more options that bit-wise ORed with zero or or more options that
modify the behaviour of the operation. modify the behaviour of the operation.
The options that may be included in The options that may be included in
.I op .I futex_op
are as follows: are as follows:
.TP .TP
.BR FUTEX_PRIVATE_FLAG " (since Linux 2.6.22)" .BR FUTEX_PRIVATE_FLAG " (since Linux 2.6.22)"
@ -147,7 +146,7 @@ measured against the
clock. clock.
.PP .PP
The operation specified in The operation specified in
.I op .I futex_op
is one of the following: is one of the following:
.TP .TP
.BR FUTEX_WAIT " (since Linux 2.6.0)" .BR FUTEX_WAIT " (since Linux 2.6.0)"
@ -458,13 +457,13 @@ The system limit on the total number of open files has been reached.
.TP .TP
.B ENOSYS .B ENOSYS
Invalid operation specified in Invalid operation specified in
.IR op . .IR futex_op .
.TP .TP
.B ENOSYS .B ENOSYS
The The
.BR FUTEX_CLOCK_REALTIME .BR FUTEX_CLOCK_REALTIME
option was specified in option was specified in
.I op , .I futex_op ,
but the accompanying operation was neither but the accompanying operation was neither
.BR FUTEX_WAIT_BITSET .BR FUTEX_WAIT_BITSET
nor nor
@ -475,7 +474,7 @@ nor
The operation timed out. The operation timed out.
.TP .TP
.B EWOULDBLOCK .B EWOULDBLOCK
.I op .I futex_op
was was
.BR FUTEX_WAIT .BR FUTEX_WAIT
and the value pointed to by and the value pointed to by