timerfd_create.2: Note behavior when timerdfd_settime() old_value is NULL

See http://bugs.debian.org/cgi-bin/bugreport.cgi?641513
timerfd_settime(2) states that "The old_value argument returns a
structure containing the setting of the timer that was current at
the time of the call"; however, it does not mention that the
caller can pass NULL to ignore that value.  Only the example
shows that the caller can pass NULL.

Reported-by: Josh Triplett <josh@joshtriplett.org>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
This commit is contained in:
Michael Kerrisk 2011-09-14 07:38:35 +02:00
parent bb0fed2e8a
commit 009cdc2239
1 changed files with 7 additions and 4 deletions

View File

@ -17,7 +17,7 @@
.\"
.\" FIXME: Linux 3.0: timerfd_settime() adds a TFD_TIMER_CANCEL_ON_SET flag.
.\"
.TH TIMERFD_CREATE 2 2009-03-10 Linux "Linux Programmer's Manual"
.TH TIMERFD_CREATE 2 2011-09-14 Linux "Linux Programmer's Manual"
.SH NAME
timerfd_create, timerfd_settime, timerfd_gettime \-
timers that notify via file descriptors
@ -167,10 +167,13 @@ that is, the timer will expire when the value of that
clock reaches the value specified in
.IR new_value.it_value ).
The
If the
.I old_value
argument returns a structure containing the setting of the timer that
was current at the time of the call; see the description of
argument is not NULL, then the
.I itimerspec
structure that it points to is used to return the setting of the timer
that was current at the time of the call;
see the description of
.BR timerfd_gettime ()
following.
.\"