futex.2: Add introductory paragraph describing 'timeout', 'uaddr2', and 'val3'

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
This commit is contained in:
Michael Kerrisk 2015-01-13 09:00:29 +01:00
parent f388ba704e
commit 36ab2074ca
1 changed files with 23 additions and 1 deletions

View File

@ -102,7 +102,29 @@ argument;
.IR val
is a value whose meaning and purpose depends on
.IR futex_op .
.PP
The remaining arguments
.RI ( timeout ,
.IR uaddr2 ,
and
.IR val3 )
are required only for certain of the futex operations described below.
Where one of these arguments is not required, it is ignored.
For several blocking operations, the
.I timeout
argument is a pointer to a
.IR timespec
structure that specifies a timeout for the operation.
However, notwithstanding the prototype shown above, for some operations,
this argument is instead a four-byte integer whose meaning
is determined by the operation.
Where it is required,
.IR uaddr2
is a pointer to a second futex that is employed by the operation.
The interpretation of the final integer argument,
.IR val3 ,
depends on the operation.
The
.I futex_op
argument consists of two parts: