Doug / smarc-fsl-linux-kernel

Download as
Browse Code ยป

Commit 6c23cbbd5056b155401b0a2b5567d530e6c750c4

Authored by Randy Dunlap
Committed by Linus Torvalds
1 parent 20f22ab42e
Exists in smarc-l5.0.0_1.0.0-ga and in 5 other branches imx_3.10.17_1.0.1_ga, imx_3.10.53_1.1.0_ga, imx_3.14.28_1.0.0_ga, smarc-imx_3.10.53_1.1.0_ga, smarc-imx_3.14.28_1.0.0_ga

futex: fix kernel-doc notation and spello 

Fix kernel-doc warning in futex.c and convert 'Returns' to the new Return:
kernel-doc notation format.

  Warning(kernel/futex.c:2286): Excess function parameter 'clockrt' description in 'futex_wait_requeue_pi'

Fix one spello.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>

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

... ... @@ -223,7 +223,8 @@
223 223 * @rw: mapping needs to be read/write (values: VERIFY_READ,
224 224 * VERIFY_WRITE)
225 225 *
226   - * Returns a negative error code or 0
  226 + * Return: a negative error code or 0
  227 + *
227 228 * The key words are stored in *key on success.
228 229 *
229 230 * For shared mappings, it's (page->index, file_inode(vma->vm_file),
... ... @@ -705,9 +706,9 @@
705 706 * be "current" except in the case of requeue pi.
706 707 * @set_waiters: force setting the FUTEX_WAITERS bit (1) or not (0)
707 708 *
708   - * Returns:
709   - * 0 - ready to wait
710   - * 1 - acquired the lock
  709 + * Return:
  710 + * 0 - ready to wait;
  711 + * 1 - acquired the lock;
711 712 * <0 - error
712 713 *
713 714 * The hb->lock and futex_key refs shall be held by the caller.
... ... @@ -1191,9 +1192,9 @@
1191 1192 * then direct futex_lock_pi_atomic() to force setting the FUTEX_WAITERS bit.
1192 1193 * hb1 and hb2 must be held by the caller.
1193 1194 *
1194   - * Returns:
1195   - * 0 - failed to acquire the lock atomicly
1196   - * 1 - acquired the lock
  1195 + * Return:
  1196 + * 0 - failed to acquire the lock atomically;
  1197 + * 1 - acquired the lock;
1197 1198 * <0 - error
1198 1199 */
1199 1200 static int futex_proxy_trylock_atomic(u32 __user *pifutex,
... ... @@ -1254,8 +1255,8 @@
1254 1255 * Requeue waiters on uaddr1 to uaddr2. In the requeue_pi case, try to acquire
1255 1256 * uaddr2 atomically on behalf of the top waiter.
1256 1257 *
1257   - * Returns:
1258   - * >=0 - on success, the number of tasks requeued or woken
  1258 + * Return:
  1259 + * >=0 - on success, the number of tasks requeued or woken;
1259 1260 * <0 - on error
1260 1261 */
1261 1262 static int futex_requeue(u32 __user *uaddr1, unsigned int flags,
... ... @@ -1536,8 +1537,8 @@
1536 1537 * The q->lock_ptr must not be held by the caller. A call to unqueue_me() must
1537 1538 * be paired with exactly one earlier call to queue_me().
1538 1539 *
1539   - * Returns:
1540   - * 1 - if the futex_q was still queued (and we removed unqueued it)
  1540 + * Return:
  1541 + * 1 - if the futex_q was still queued (and we removed unqueued it);
1541 1542 * 0 - if the futex_q was already removed by the waking thread
1542 1543 */
1543 1544 static int unqueue_me(struct futex_q *q)
... ... @@ -1707,9 +1708,9 @@
1707 1708 * the pi_state owner as well as handle race conditions that may allow us to
1708 1709 * acquire the lock. Must be called with the hb lock held.
1709 1710 *
1710   - * Returns:
1711   - * 1 - success, lock taken
1712   - * 0 - success, lock not taken
  1711 + * Return:
  1712 + * 1 - success, lock taken;
  1713 + * 0 - success, lock not taken;
1713 1714 * <0 - on error (-EFAULT)
1714 1715 */
1715 1716 static int fixup_owner(u32 __user *uaddr, struct futex_q *q, int locked)
... ... @@ -1824,8 +1825,8 @@
1824 1825 * Return with the hb lock held and a q.key reference on success, and unlocked
1825 1826 * with no q.key reference on failure.
1826 1827 *
1827   - * Returns:
1828   - * 0 - uaddr contains val and hb has been locked
  1828 + * Return:
  1829 + * 0 - uaddr contains val and hb has been locked;
1829 1830 * <1 - -EFAULT or -EWOULDBLOCK (uaddr does not contain val) and hb is unlocked
1830 1831 */
1831 1832 static int futex_wait_setup(u32 __user *uaddr, u32 val, unsigned int flags,
... ... @@ -2203,9 +2204,9 @@
2203 2204 * the wakeup and return the appropriate error code to the caller. Must be
2204 2205 * called with the hb lock held.
2205 2206 *
2206   - * Returns
2207   - * 0 - no early wakeup detected
2208   - * <0 - -ETIMEDOUT or -ERESTARTNOINTR
  2207 + * Return:
  2208 + * 0 = no early wakeup detected;
  2209 + * <0 = -ETIMEDOUT or -ERESTARTNOINTR
2209 2210 */
2210 2211 static inline
2211 2212 int handle_early_requeue_pi_wakeup(struct futex_hash_bucket *hb,
... ... @@ -2247,7 +2248,6 @@
2247 2248 * @val: the expected value of uaddr
2248 2249 * @abs_time: absolute timeout
2249 2250 * @bitset: 32 bit wakeup bitset set by userspace, defaults to all
2250   - * @clockrt: whether to use CLOCK_REALTIME (1) or CLOCK_MONOTONIC (0)
2251 2251 * @uaddr2: the pi futex we will take prior to returning to user-space
2252 2252 *
2253 2253 * The caller will wait on uaddr and will be requeued by futex_requeue() to
... ... @@ -2258,7 +2258,7 @@
2258 2258 * there was a need to.
2259 2259 *
2260 2260 * We call schedule in futex_wait_queue_me() when we enqueue and return there
2261   - * via the following:
  2261 + * via the following--
2262 2262 * 1) wakeup on uaddr2 after an atomic lock acquisition by futex_requeue()
2263 2263 * 2) wakeup on uaddr2 after a requeue
2264 2264 * 3) signal
... ... @@ -2276,8 +2276,8 @@
2276 2276 *
2277 2277 * If 4 or 7, we cleanup and return with -ETIMEDOUT.
2278 2278 *
2279   - * Returns:
2280   - * 0 - On success
  2279 + * Return:
  2280 + * 0 - On success;
2281 2281 * <0 - On error
2282 2282 */
2283 2283 static int futex_wait_requeue_pi(u32 __user *uaddr, unsigned int flags,