diff options
| author | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2017-05-17 11:46:19 +0200 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2017-07-14 21:58:03 +0200 |
| commit | 773810d30e7d81b8308fea272ed2ec3d832a6018 (patch) | |
| tree | 85d726a023baf520515cba4a8d8dd098e22ce113 /Documentation/robust-futexes.txt | |
| parent | robust-futex-ABI.txt: standardize document format (diff) | |
| download | linux-773810d30e7d81b8308fea272ed2ec3d832a6018.tar.xz linux-773810d30e7d81b8308fea272ed2ec3d832a6018.zip | |
robust-futexes.txt: standardize document format
Each text file under Documentation follows a different
format. Some doesn't even have titles!
Change its representation to follow the adopted standard,
using ReST markups for it to be parseable by Sphinx:
- add a title for the document;
- mark literal blocks;
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'Documentation/robust-futexes.txt')
| -rw-r--r-- | Documentation/robust-futexes.txt | 12 |
1 files changed, 8 insertions, 4 deletions
diff --git a/Documentation/robust-futexes.txt b/Documentation/robust-futexes.txt index 61c22d608759..6c42c75103eb 100644 --- a/Documentation/robust-futexes.txt +++ b/Documentation/robust-futexes.txt @@ -1,4 +1,8 @@ -Started by: Ingo Molnar <mingo@redhat.com> +======================================== +A description of what robust futexes are +======================================== + +:Started by: Ingo Molnar <mingo@redhat.com> Background ---------- @@ -163,7 +167,7 @@ Implementation details ---------------------- The patch adds two new syscalls: one to register the userspace list, and -one to query the registered list pointer: +one to query the registered list pointer:: asmlinkage long sys_set_robust_list(struct robust_list_head __user *head, @@ -185,7 +189,7 @@ straightforward. The kernel doesn't have any internal distinction between robust and normal futexes. If a futex is found to be held at exit time, the kernel sets the -following bit of the futex word: +following bit of the futex word:: #define FUTEX_OWNER_DIED 0x40000000 @@ -193,7 +197,7 @@ and wakes up the next futex waiter (if any). User-space does the rest of the cleanup. Otherwise, robust futexes are acquired by glibc by putting the TID into -the futex field atomically. Waiters set the FUTEX_WAITERS bit: +the futex field atomically. Waiters set the FUTEX_WAITERS bit:: #define FUTEX_WAITERS 0x80000000 |