Commit d96ee56c authored by Darren Hart's avatar Darren Hart Committed by Ingo Molnar
Browse files

futex: Make function kernel-doc commentary consistent 



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: default avatarDarren Hart <dvhltc@us.ibm.com>
Acked-by: default avatarPeter 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: default avatarIngo Molnar <mingo@elte.hu>
parent d40d65c8

kernel/futex.c

+21 −20
Original line number Diff line number Diff line
@@ -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

 * @fshared:	0 for a PROCESS_PRIVATE futex, 1 for PROCESS_SHARED

 * @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

 * 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);

}



/*

 * 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

 *

 * Slow path to fixup the fault we just took in the atomic write
@@ -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

 * @hb:			the pi futex hash bucket

 * @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

 * q:	the futex_q

 * key:	the key of the requeue target futex

 * hb:  the hash_bucket of the requeue target futex

 * @q:		the futex_q

 * @key:	the key 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

 * target futex if it is uncontended or via a lock steal.  Set the futex_q key
@@ -2319,7 +2320,7 @@ 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

 * @len:	length of the list-head, as userspace expects

 */
@@ -2340,7 +2341,7 @@ 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]

 * @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

CRA Git | Maintained and supported by SUSTech CRA and CCSE