futex.2: Document FUTEX_LOCK_PI2
commite79977aeecf4405707e42efd6294ed852d5e152d
authorKurt Kanzenbach <kurt@linutronix.de>
Sun, 8 Aug 2021 08:41:16 +0000 (8 10:41 +0200)
committerMichael Kerrisk <mtk.manpages@gmail.com>
Mon, 9 Aug 2021 09:44:12 +0000 (9 11:44 +0200)
tree1266a877069cbed2f30960245f69c3f20f0b13de
parent7fc5fc967d2b1a410548fc1521dc5a9fb5a63f8d
futex.2: Document FUTEX_LOCK_PI2

FUTEX_LOCK_PI2 is a new futex operation which was recently introduced into the
Linux kernel. It works exactly like FUTEX_LOCK_PI. However, it has support for
selectable clocks for timeouts. By default CLOCK_MONOTONIC is used. If
FUTEX_CLOCK_REALTIME is specified then the timeout is measured against
CLOCK_REALTIME.

This new operation addresses an inconsistency in the futex interface:
FUTEX_LOCK_PI only works with timeouts based on CLOCK_REALTIME in contrast to
all the other PI operations.

Document the FUTEX_LOCK_PI2 command.

Signed-off-by: Kurt Kanzenbach <kurt@linutronix.de>
Reviewed-by: Thomas Gleixner <tglx@linutronix.de>
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
man2/futex.2