adulau/aha
1
0
Fork 0
mirror of https://github.com/adulau/aha.git synced 2024-12-28 03:36:19 +00:00
Code Issues Projects Releases Packages Wiki Activity

futex: Make function kernel-doc commentary consistent

Browse source 
Make the existing function kernel-doc consistent throughout
futex.c, following Documentation/kernel-doc-nano-howto.txt as
closely as possible.

When unsure, at least be consistent within futex.c.

Signed-off-by: Darren Hart <dvhltc@us.ibm.com>
Acked-by: Peter Zijlstra <peterz@infradead.org>
Cc: Steven Rostedt <rostedt@goodmis.org>
Cc: Eric Dumazet <eric.dumazet@gmail.com>
Cc: Dinakar Guniguntala <dino@in.ibm.com>
Cc: John Stultz <johnstul@us.ibm.com>
LKML-Reference: <20090922053022.8717.13339.stgit@Aeon>
Signed-off-by: Ingo Molnar <mingo@elte.hu>
This commit is contained in:
Darren Hart 2009-09-21 22:30:22 -07:00 committed by Ingo Molnar
parent d40d65c8db
commit d96ee56ce0
1 changed files with 21 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

41
kernel/futex.c
View file

@ -198,11 +198,12 @@ static void drop_futex_key_refs(union futex_key *key)
} }
/** /**
* get_futex_key - Get parameters which are the keys for a futex. * get_futex_key() - Get parameters which are the keys for a futex
* @uaddr: virtual address of the futex * @uaddr: virtual address of the futex
* @fshared: 0 for a PROCESS_PRIVATE futex, 1 for PROCESS_SHARED * @fshared: 0 for a PROCESS_PRIVATE futex, 1 for PROCESS_SHARED
* @key: address where result is stored. * @key: address where result is stored.
* @rw: mapping needs to be read/write (values: VERIFY_READ, VERIFY_WRITE) * @rw: mapping needs to be read/write (values: VERIFY_READ,
* VERIFY_WRITE)
* *
* Returns a negative error code or 0 * Returns a negative error code or 0
* The key words are stored in *key on success. * The key words are stored in *key on success.
@ -288,8 +289,8 @@ void put_futex_key(int fshared, union futex_key *key)
drop_futex_key_refs(key); drop_futex_key_refs(key);
} }
/* /**
* fault_in_user_writeable - fault in user address and verify RW access * fault_in_user_writeable() - Fault in user address and verify RW access
* @uaddr: pointer to faulting user space address * @uaddr: pointer to faulting user space address
* *
* Slow path to fixup the fault we just took in the atomic write * Slow path to fixup the fault we just took in the atomic write
@ -309,8 +310,8 @@ static int fault_in_user_writeable(u32 __user *uaddr)
/** /**
* futex_top_waiter() - Return the highest priority waiter on a futex * futex_top_waiter() - Return the highest priority waiter on a futex
* @hb: the hash bucket the futex_q's reside in * @hb: the hash bucket the futex_q's reside in
* @key: the futex key (to distinguish it from other futex futex_q's) * @key: the futex key (to distinguish it from other futex futex_q's)
* *
* Must be called with the hb lock held. * Must be called with the hb lock held.
*/ */
@ -588,7 +589,7 @@ lookup_pi_state(u32 uval, struct futex_hash_bucket *hb,
} }
/** /**
* futex_lock_pi_atomic() - atomic work required to acquire a pi aware futex * futex_lock_pi_atomic() - Atomic work required to acquire a pi aware futex
* @uaddr: the pi futex user address * @uaddr: the pi futex user address
* @hb: the pi futex hash bucket * @hb: the pi futex hash bucket
* @key: the futex key associated with uaddr and hb * @key: the futex key associated with uaddr and hb
@ -1011,9 +1012,9 @@ void requeue_futex(struct futex_q *q, struct futex_hash_bucket *hb1,
/** /**
* requeue_pi_wake_futex() - Wake a task that acquired the lock during requeue * requeue_pi_wake_futex() - Wake a task that acquired the lock during requeue
* q: the futex_q * @q: the futex_q
* key: the key of the requeue target futex * @key: the key of the requeue target futex
* hb: the hash_bucket of the requeue target futex * @hb: the hash_bucket of the requeue target futex
* *
* During futex_requeue, with requeue_pi=1, it is possible to acquire the * During futex_requeue, with requeue_pi=1, it is possible to acquire the
* target futex if it is uncontended or via a lock steal. Set the futex_q key * target futex if it is uncontended or via a lock steal. Set the futex_q key
@ -2319,9 +2320,9 @@ out:
*/ */
/** /**
* sys_set_robust_list - set the robust-futex list head of a task * sys_set_robust_list() - Set the robust-futex list head of a task
* @head: pointer to the list-head * @head: pointer to the list-head
* @len: length of the list-head, as userspace expects * @len: length of the list-head, as userspace expects
*/ */
SYSCALL_DEFINE2(set_robust_list, struct robust_list_head __user *, head, SYSCALL_DEFINE2(set_robust_list, struct robust_list_head __user *, head,
size_t, len) size_t, len)
@ -2340,10 +2341,10 @@ SYSCALL_DEFINE2(set_robust_list, struct robust_list_head __user *, head,
} }
/** /**
* sys_get_robust_list - get the robust-futex list head of a task * sys_get_robust_list() - Get the robust-futex list head of a task
* @pid: pid of the process [zero for current task] * @pid: pid of the process [zero for current task]
* @head_ptr: pointer to a list-head pointer, the kernel fills it in * @head_ptr: pointer to a list-head pointer, the kernel fills it in
* @len_ptr: pointer to a length field, the kernel fills in the header size * @len_ptr: pointer to a length field, the kernel fills in the header size
*/ */
SYSCALL_DEFINE3(get_robust_list, int, pid, SYSCALL_DEFINE3(get_robust_list, int, pid,
struct robust_list_head __user * __user *, head_ptr, struct robust_list_head __user * __user *, head_ptr,