Eric Lee / linux-smarc-t335x-v3.2

Download as
Browse Code ยป

Commit d96ee56ce0582967fba9f3f0ac4503957147bea6

Authored by Darren Hart
Committed by Ingo Molnar
1 parent d40d65c8db
Exists in master and in 4 other branches v3.2_AM335xPSP_04.06.00.11, v3.2_NEWT335xPSP_04.06.00.11, v3.2_SBC_SMARTMEN, v3.2_SMARCT335xPSP_04.06.00.11

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: 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>

Showing 1 changed file with 21 additions and 20 deletions Side-by-side Diff

... ... @@ -198,11 +198,12 @@
198 198 }
199 199  
200 200 /**
201   - * get_futex_key - Get parameters which are the keys for a futex.
202   - * @uaddr: virtual address of the futex
203   - * @fshared: 0 for a PROCESS_PRIVATE futex, 1 for PROCESS_SHARED
204   - * @key: address where result is stored.
205   - * @rw: mapping needs to be read/write (values: VERIFY_READ, VERIFY_WRITE)
  201 + * get_futex_key() - Get parameters which are the keys for a futex
  202 + * @uaddr: virtual address of the futex
  203 + * @fshared: 0 for a PROCESS_PRIVATE futex, 1 for PROCESS_SHARED
  204 + * @key: address where result is stored.
  205 + * @rw: mapping needs to be read/write (values: VERIFY_READ,
  206 + * VERIFY_WRITE)
206 207 *
207 208 * Returns a negative error code or 0
208 209 * The key words are stored in *key on success.
... ... @@ -288,8 +289,8 @@
288 289 drop_futex_key_refs(key);
289 290 }
290 291  
291   -/*
292   - * fault_in_user_writeable - fault in user address and verify RW access
  292 +/**
  293 + * fault_in_user_writeable() - Fault in user address and verify RW access
293 294 * @uaddr: pointer to faulting user space address
294 295 *
295 296 * Slow path to fixup the fault we just took in the atomic write
... ... @@ -309,8 +310,8 @@
309 310  
310 311 /**
311 312 * futex_top_waiter() - Return the highest priority waiter on a futex
312   - * @hb: the hash bucket the futex_q's reside in
313   - * @key: the futex key (to distinguish it from other futex futex_q's)
  313 + * @hb: the hash bucket the futex_q's reside in
  314 + * @key: the futex key (to distinguish it from other futex futex_q's)
314 315 *
315 316 * Must be called with the hb lock held.
316 317 */
... ... @@ -588,7 +589,7 @@
588 589 }
589 590  
590 591 /**
591   - * futex_lock_pi_atomic() - atomic work required to acquire a pi aware futex
  592 + * futex_lock_pi_atomic() - Atomic work required to acquire a pi aware futex
592 593 * @uaddr: the pi futex user address
593 594 * @hb: the pi futex hash bucket
594 595 * @key: the futex key associated with uaddr and hb
... ... @@ -1011,9 +1012,9 @@
1011 1012  
1012 1013 /**
1013 1014 * requeue_pi_wake_futex() - Wake a task that acquired the lock during requeue
1014   - * q: the futex_q
1015   - * key: the key of the requeue target futex
1016   - * hb: the hash_bucket of the requeue target futex
  1015 + * @q: the futex_q
  1016 + * @key: the key of the requeue target futex
  1017 + * @hb: the hash_bucket of the requeue target futex
1017 1018 *
1018 1019 * During futex_requeue, with requeue_pi=1, it is possible to acquire the
1019 1020 * target futex if it is uncontended or via a lock steal. Set the futex_q key
... ... @@ -2319,9 +2320,9 @@
2319 2320 */
2320 2321  
2321 2322 /**
2322   - * sys_set_robust_list - set the robust-futex list head of a task
2323   - * @head: pointer to the list-head
2324   - * @len: length of the list-head, as userspace expects
  2323 + * sys_set_robust_list() - Set the robust-futex list head of a task
  2324 + * @head: pointer to the list-head
  2325 + * @len: length of the list-head, as userspace expects
2325 2326 */
2326 2327 SYSCALL_DEFINE2(set_robust_list, struct robust_list_head __user *, head,
2327 2328 size_t, len)
... ... @@ -2340,10 +2341,10 @@
2340 2341 }
2341 2342  
2342 2343 /**
2343   - * sys_get_robust_list - get the robust-futex list head of a task
2344   - * @pid: pid of the process [zero for current task]
2345   - * @head_ptr: pointer to a list-head pointer, the kernel fills it in
2346   - * @len_ptr: pointer to a length field, the kernel fills in the header size
  2344 + * sys_get_robust_list() - Get the robust-futex list head of a task
  2345 + * @pid: pid of the process [zero for current task]
  2346 + * @head_ptr: pointer to a list-head pointer, the kernel fills it in
  2347 + * @len_ptr: pointer to a length field, the kernel fills in the header size
2347 2348 */
2348 2349 SYSCALL_DEFINE3(get_robust_list, int, pid,
2349 2350 struct robust_list_head __user * __user *, head_ptr,