linux-man.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Alejandro Colomar <alx.manpages@gmail.com>
To: mtk.manpages@gmail.com
Cc: Alejandro Colomar <alx.manpages@gmail.com>, linux-man@vger.kernel.org
Subject: [PATCH 11/32] futex.2: Minor tweaks to Kurt's patch
Date: Wed, 28 Jul 2021 22:19:47 +0200	[thread overview]
Message-ID: <20210728202008.3158-12-alx.manpages@gmail.com> (raw)
In-Reply-To: <20210728202008.3158-1-alx.manpages@gmail.com>

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
---
 man2/futex.2 | 69 ++++++++++++++++++++++++++--------------------------
 1 file changed, 34 insertions(+), 35 deletions(-)

diff --git a/man2/futex.2 b/man2/futex.2
index 2f340e0e0..217b76734 100644
--- a/man2/futex.2
+++ b/man2/futex.2
@@ -222,9 +222,9 @@ This allows the kernel to make some additional performance optimizations.
 .\" taking reference counts on file backing store, and so on.
 .IP
 As a convenience,
-.IR <linux/futex.h>
+.I <linux/futex.h>
 defines a set of constants with the suffix
-.BR _PRIVATE
+.B _PRIVATE
 that are equivalents of all of the operations listed below,
 .\" except the obsolete FUTEX_FD, for which the "private" flag was
 .\" meaningless
@@ -247,19 +247,19 @@ This option bit can be employed only with the
 and
 (since Linux v5.14.0)
 .\" commit bf22a6976897977b0a3f1aeba6823c959fc4fdae
-.BR FUTEX_LOCK_PI2
+.B FUTEX_LOCK_PI2
 operations.
 .IP
 If this option is set, the kernel measures the
 .I timeout
 against the
-.BR CLOCK_REALTIME
+.B CLOCK_REALTIME
 clock.
 .IP
 If this option is not set, the kernel measures the
 .I timeout
 against the
-.BR CLOCK_MONOTONIC
+.B CLOCK_MONOTONIC
 clock.
 .PP
 The operation specified in
@@ -968,9 +968,8 @@ PI futexes are operated on by specifying one of the values listed below in
 Note that the PI futex operations must be used as paired operations
 and are subject to some additional requirements:
 .IP * 3
-.B FUTEX_LOCK_PI
-,
-.B FUTEX_LOCK_PI2
+.BR FUTEX_LOCK_PI ,
+.BR FUTEX_LOCK_PI2 ,
 and
 .B FUTEX_TRYLOCK_PI
 pair with
@@ -1123,7 +1122,7 @@ The
 .IR uaddr2 ,
 .IR val ,
 and
-.IR val3
+.I val3
 arguments are ignored.
 .\"
 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
@@ -1135,7 +1134,7 @@ This operation works similar like
 .BR FUTEX_LOCK_PI .
 The only difference is the
 timeout argument.
-.BR FUTEX_LOCK_PI2
+.B FUTEX_LOCK_PI2
 has support for selectable clocks.
 .IP
 If
@@ -1466,7 +1465,7 @@ The value pointed to by
 is not equal to the expected value
 .IR val3 .
 .TP
-.BR EAGAIN
+.B EAGAIN
 .RB ( FUTEX_LOCK_PI ,
 .BR FUTEX_LOCK_PI2 ,
 .BR FUTEX_TRYLOCK_PI ,
@@ -1480,7 +1479,7 @@ is about to exit,
 but has not yet handled the internal state cleanup.
 Try again.
 .TP
-.BR EDEADLK
+.B EDEADLK
 .RB ( FUTEX_LOCK_PI ,
 .BR FUTEX_LOCK_PI2 ,
 .BR FUTEX_TRYLOCK_PI ,
@@ -1522,18 +1521,18 @@ a spurious wakeup; since Linux 2.6.22, this no longer happens.
 .TP
 .B EINVAL
 The operation in
-.IR futex_op
+.I futex_op
 is one of those that employs a timeout, but the supplied
 .I timeout
 argument was invalid
 .RI ( tv_sec
 was less than zero, or
-.IR tv_nsec
+.I tv_nsec
 was not less than 1,000,000,000).
 .TP
 .B EINVAL
 The operation specified in
-.IR futex_op
+.I futex_op
 employs one or both of the pointers
 .I uaddr
 and
@@ -1545,17 +1544,17 @@ the address is not four-byte-aligned.
 .RB ( FUTEX_WAIT_BITSET ,
 .BR FUTEX_WAKE_BITSET )
 The bit mask supplied in
-.IR val3
+.I val3
 is zero.
 .TP
 .B EINVAL
 .RB ( FUTEX_CMP_REQUEUE_PI )
 .I uaddr
 equals
-.IR uaddr2
+.I uaddr2
 (i.e., an attempt was made to requeue to the same futex).
 .TP
-.BR EINVAL
+.B EINVAL
 .RB ( FUTEX_FD )
 The signal number supplied in
 .I val
@@ -1570,9 +1569,9 @@ is invalid.
 The kernel detected an inconsistency between the user-space state at
 .I uaddr
 and the kernel state\(emthat is, it detected a waiter which waits in
-.BR FUTEX_LOCK_PI
+.B FUTEX_LOCK_PI
 or
-.BR FUTEX_LOCK_PI2
+.B FUTEX_LOCK_PI2
 on
 .IR uaddr .
 .TP
@@ -1588,7 +1587,7 @@ This indicates either state corruption
 or that the kernel found a waiter on
 .I uaddr
 which is waiting via
-.BR FUTEX_WAIT
+.B FUTEX_WAIT
 or
 .BR FUTEX_WAIT_BITSET .
 .TP
@@ -1601,9 +1600,9 @@ and the kernel state;
 .\"	The kernel sees: I have non PI state for a futex you tried to
 .\"     tell me was PI
 that is, the kernel detected a waiter which waits via
-.BR FUTEX_WAIT
+.B FUTEX_WAIT
 or
-.BR FUTEX_WAIT_BITSET
+.B FUTEX_WAIT_BITSET
 on
 .IR uaddr2 .
 .TP
@@ -1613,9 +1612,9 @@ The kernel detected an inconsistency between the user-space state at
 .I uaddr
 and the kernel state;
 that is, the kernel detected a waiter which waits via
-.BR FUTEX_WAIT
+.B FUTEX_WAIT
 or
-.BR FUTEX_WAIT_BITSET
+.B FUTEX_WAIT_BITSET
 on
 .IR uaddr .
 .TP
@@ -1627,9 +1626,9 @@ and the kernel state;
 that is, the kernel detected a waiter which waits on
 .I uaddr
 via
-.BR FUTEX_LOCK_PI
+.B FUTEX_LOCK_PI
 or
-.BR FUTEX_LOCK_PI2
+.B FUTEX_LOCK_PI2
 (instead of
 .BR FUTEX_WAIT_REQUEUE_PI ).
 .TP
@@ -1656,7 +1655,7 @@ Invalid argument.
 .RB ( FUTEX_FD )
 The system-wide limit on the total number of open files has been reached.
 .TP
-.BR ENOMEM
+.B ENOMEM
 .RB ( FUTEX_LOCK_PI ,
 .BR FUTEX_LOCK_PI2 ,
 .BR FUTEX_TRYLOCK_PI ,
@@ -1669,7 +1668,7 @@ Invalid operation specified in
 .TP
 .B ENOSYS
 The
-.BR FUTEX_CLOCK_REALTIME
+.B FUTEX_CLOCK_REALTIME
 option was specified in
 .IR futex_op ,
 but the accompanying operation was neither
@@ -1679,7 +1678,7 @@ but the accompanying operation was neither
 nor
 .BR FUTEX_LOCK_PI2 .
 .TP
-.BR ENOSYS
+.B ENOSYS
 .RB ( FUTEX_LOCK_PI ,
 .BR FUTEX_LOCK_PI2 ,
 .BR FUTEX_TRYLOCK_PI ,
@@ -1690,7 +1689,7 @@ A run-time check determined that the operation is not available.
 The PI-futex operations are not implemented on all architectures and
 are not supported on some CPU variants.
 .TP
-.BR EPERM
+.B EPERM
 .RB ( FUTEX_LOCK_PI ,
 .BR FUTEX_LOCK_PI2 ,
 .BR FUTEX_TRYLOCK_PI ,
@@ -1703,11 +1702,11 @@ the futex at
 .IR uaddr2 ).
 (This may be caused by a state corruption in user space.)
 .TP
-.BR EPERM
+.B EPERM
 .RB ( FUTEX_UNLOCK_PI )
 The caller does not own the lock represented by the futex word.
 .TP
-.BR ESRCH
+.B ESRCH
 .RB ( FUTEX_LOCK_PI ,
 .BR FUTEX_LOCK_PI2 ,
 .BR FUTEX_TRYLOCK_PI ,
@@ -1716,7 +1715,7 @@ The thread ID in the futex word at
 .I uaddr
 does not exist.
 .TP
-.BR ESRCH
+.B ESRCH
 .RB ( FUTEX_CMP_REQUEUE_PI )
 The thread ID in the futex word at
 .I uaddr2
@@ -1724,7 +1723,7 @@ does not exist.
 .TP
 .B ETIMEDOUT
 The operation in
-.IR futex_op
+.I futex_op
 employed the timeout specified in
 .IR timeout ,
 and the timeout expired before the operation completed.
-- 
2.32.0


  parent reply	other threads:[~2021-07-28 20:20 UTC|newest]

Thread overview: 92+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-07-28 20:19 [PATCH 00/32] Patches from others Alejandro Colomar
2021-07-28 20:19 ` [PATCH 01/32] readv2: Note preadv2(..., RWF_NOWAIT) bug in BUGS section Alejandro Colomar
2021-08-08  2:29   ` Michael Kerrisk (man-pages)
2021-07-28 20:19 ` [PATCH 02/32] readv.2: Minor tweaks to Will's patch Alejandro Colomar
2021-08-08  2:30   ` Michael Kerrisk (man-pages)
2021-08-08  2:42     ` Michael Kerrisk (man-pages)
2021-07-28 20:19 ` [PATCH 03/32] vdso.7: Remove outdated limitation for powerpc Alejandro Colomar
2021-08-08  0:17   ` Michael Kerrisk (man-pages)
2021-08-08  0:21     ` Alejandro Colomar (man-pages)
2021-07-28 20:19 ` [PATCH 04/32] vdso.7: Add y2038 compliant gettime for ppc/32 Alejandro Colomar
2021-08-08  0:48   ` Michael Kerrisk (man-pages)
2021-08-08  1:01     ` Alejandro Colomar (man-pages)
2021-08-08  2:25       ` Michael Kerrisk (man-pages)
2021-08-08  2:22   ` Michael Kerrisk (man-pages)
2021-07-28 20:19 ` [PATCH 05/32] posixoptions.7: Fix legacy functions list (s/getcwd/getwd/) Alejandro Colomar
2021-08-08  0:55   ` Michael Kerrisk (man-pages)
2021-07-28 20:19 ` [PATCH 06/32] man2/fallocate.2: tfix documentation of shared blocks Alejandro Colomar
2021-08-08  0:54   ` Michael Kerrisk (man-pages)
2021-07-28 20:19 ` [PATCH 07/32] printf.3: wfix Alejandro Colomar
2021-08-07 21:34   ` Michael Kerrisk (man-pages)
2021-08-07 22:20     ` Alejandro Colomar (man-pages)
2021-08-07 22:32       ` Alejandro Colomar (man-pages)
2021-08-07 23:10         ` Michael Kerrisk (man-pages)
2021-08-11 20:55           ` Sergey Petrakov
2021-08-11 22:33             ` Michael Kerrisk (man-pages)
2021-07-28 20:19 ` [PATCH 08/32] Various pages: Consistently use '*argv[]' Alejandro Colomar
2021-08-07 21:35   ` Michael Kerrisk (man-pages)
2021-07-28 20:19 ` [PATCH 09/32] path_resolution.7: tfix Alejandro Colomar
2021-08-07 21:37   ` Michael Kerrisk (man-pages)
2021-07-28 20:19 ` [PATCH 10/32] futex.2: Document FUTEX_LOCK_PI2 Alejandro Colomar
2021-07-29 10:18   ` Alejandro Colomar (man-pages)
2021-08-07 21:38     ` Michael Kerrisk (man-pages)
2021-07-28 20:19 ` Alejandro Colomar [this message]
2021-07-29 10:24   ` [PATCH 11/32] futex.2: Minor tweaks to Kurt's patch Alejandro Colomar (man-pages)
2021-08-07 21:38     ` Michael Kerrisk (man-pages)
2021-07-28 20:19 ` [PATCH 12/32] capabilities.7: tfix Alejandro Colomar
2021-08-07 21:39   ` Michael Kerrisk (man-pages)
2021-07-28 20:19 ` [PATCH 13/32] user_namespaces.7: fix a ref Alejandro Colomar
2021-08-07 21:40   ` Michael Kerrisk (man-pages)
2021-07-28 20:19 ` [PATCH 14/32] capabilities.7, user_namespaces.7: describe CAP_SETFCAP Alejandro Colomar
2021-08-08  2:54   ` Michael Kerrisk (man-pages)
2021-08-08  9:09   ` Michael Kerrisk (man-pages)
2021-07-28 20:19 ` [PATCH 15/32] capabilities.7: Minor tweaks to Kir's patch Alejandro Colomar
2021-07-29 11:16   ` Alejandro Colomar (man-pages)
2021-08-08  3:03   ` Michael Kerrisk (man-pages)
2021-07-28 20:19 ` [PATCH 16/32] seccomp_unotify.2: Add doc for SECCOMP_ADDFD_FLAG_SEND Alejandro Colomar
2021-08-08  1:01   ` Michael Kerrisk (man-pages)
2021-08-09  9:42     ` Rodrigo Campos
2021-07-28 20:19 ` [PATCH 17/32] seccomp_unotify.2: Minor tweaks to Rodrigo's patch Alejandro Colomar
2021-07-29 11:15   ` Alejandro Colomar (man-pages)
2021-08-08  1:13   ` Michael Kerrisk (man-pages)
2021-08-08  1:22     ` Alejandro Colomar (man-pages)
2021-07-28 20:19 ` [PATCH 18/32] recv.2: tfix Alejandro Colomar
2021-08-07 21:43   ` Michael Kerrisk (man-pages)
2021-07-28 20:19 ` [PATCH 19/32] ascii.7: add vertical rule to separate the two columns Alejandro Colomar
2021-08-07 22:46   ` Michael Kerrisk (man-pages)
2021-07-28 20:19 ` [PATCH 20/32] wait.2: Add ESRCH for when pid == INT_MIN Alejandro Colomar
2021-08-07 23:05   ` Michael Kerrisk (man-pages)
2021-07-28 20:19 ` [PATCH 21/32] seccomp_unotify.2: tfix Alejandro Colomar
2021-08-08  1:13   ` Michael Kerrisk (man-pages)
2021-07-28 20:19 ` [PATCH 22/32] proc.5: tfix Alejandro Colomar
2021-08-07 22:55   ` Michael Kerrisk (man-pages)
2021-07-28 20:19 ` [PATCH 23/32] scripts/bash_aliases: tfix Alejandro Colomar
2021-08-07 22:47   ` Michael Kerrisk (man-pages)
2021-07-28 20:20 ` [PATCH 24/32] namespaces.7: fix confusion caused by text reorganization Alejandro Colomar
2021-08-07 23:48   ` Michael Kerrisk (man-pages)
2021-07-28 20:20 ` [PATCH 25/32] pipe.7: also mention writev(2) in atomicity sexion Alejandro Colomar
2021-08-08  9:30   ` Michael Kerrisk (man-pages)
2021-07-28 20:20 ` [PATCH 26/32] tkill.2: tfix Alejandro Colomar
2021-08-07 22:48   ` Michael Kerrisk (man-pages)
2021-07-28 20:20 ` [PATCH 27/32] strstr.3: Add special case for empty needle Alejandro Colomar
2021-08-07 23:53   ` Michael Kerrisk (man-pages)
2021-07-28 20:20 ` [PATCH 28/32] sigaction.2: Document SA_EXPOSE_TAGBITS and the flag support detection protocol Alejandro Colomar
2021-08-08 21:32   ` Michael Kerrisk (man-pages)
2021-07-28 20:20 ` [PATCH 29/32] sigaction.2: Apply minor tweaks to Peter's patch Alejandro Colomar
2021-07-29 11:14   ` Alejandro Colomar (man-pages)
2021-08-08 21:32   ` Michael Kerrisk (man-pages)
2021-07-28 20:20 ` [PATCH 30/32] strlen.3, wcslen.3: Add recommendations for safer variants Alejandro Colomar
2021-08-07 23:45   ` Michael Kerrisk (man-pages)
2021-08-08  0:04     ` Alejandro Colomar (man-pages)
2021-08-08  0:16     ` Alejandro Colomar (man-pages)
2021-08-08  1:20       ` Michael Kerrisk (man-pages)
2021-08-08  1:24         ` Alejandro Colomar (man-pages)
2021-08-08  2:18           ` Michael Kerrisk (man-pages)
2021-08-08 19:44       ` Jonny Grant
2021-07-28 20:20 ` [PATCH 31/32] time.2: wfix regarding year-2038 Alejandro Colomar
2021-07-29 10:45   ` G. Branden Robinson
2021-07-30  1:25     ` Viet Than
2021-08-07 23:59       ` Michael Kerrisk (man-pages)
2021-07-28 20:20 ` [PATCH 32/32] execve.2: Fix absolute/relative pathname Alejandro Colomar
2021-08-08  2:02   ` Michael Kerrisk (man-pages)
2021-08-08 21:34 ` [PATCH 00/32] Patches from others Michael Kerrisk (man-pages)

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20210728202008.3158-12-alx.manpages@gmail.com \
    --to=alx.manpages@gmail.com \
    --cc=linux-man@vger.kernel.org \
    --cc=mtk.manpages@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).