iv/linux
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

robust-futexes.txt: standardize document format

Browse Source 
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>
This commit is contained in:
Mauro Carvalho Chehab 2017-05-17 06:46:19 -03:00 committed by Jonathan Corbet
parent ce3a966931
commit 773810d30e
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
Documentation/robust-futexes.txt
View File

@ -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 Background
---------- ----------
@ -163,7 +167,7 @@ Implementation details
---------------------- ----------------------
The patch adds two new syscalls: one to register the userspace list, and 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 asmlinkage long
sys_set_robust_list(struct robust_list_head __user *head, 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. robust and normal futexes.
If a futex is found to be held at exit time, the kernel sets the 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 #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. the cleanup.
Otherwise, robust futexes are acquired by glibc by putting the TID into 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 #define FUTEX_WAITERS 0x80000000