OpenE2K
/
linux
6
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

mutex, futex: adjust kernel-doc markups to generate ReST 

There are a few issues on some kernel-doc markups that was
causing troubles with kernel-doc output on ReST format:

./kernel/futex.c:492: WARNING: Inline emphasis start-string without end-string.
./kernel/futex.c:1264: WARNING: Block quote ends without a blank line; unexpected unindent.
./kernel/futex.c:1721: WARNING: Block quote ends without a blank line; unexpected unindent.
./kernel/futex.c:2338: WARNING: Block quote ends without a blank line; unexpected unindent.
./kernel/futex.c:2426: WARNING: Block quote ends without a blank line; unexpected unindent.
./kernel/futex.c:2899: WARNING: Block quote ends without a blank line; unexpected unindent.
./kernel/futex.c:2972: WARNING: Block quote ends without a blank line; unexpected unindent.

Fix them.

No functional changes.

Acked-by: Darren Hart (VMware) <dvhart@infradead.org>
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
This commit is contained in:
Mauro Carvalho Chehab 2017-05-11 10:17:45 -03:00
parent e548cdeffc
commit 7b4ff1adb5
3 changed files with 26 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
include/linux/mutex.h
View File

@ -214,9 +214,9 @@ enum mutex_trylock_recursive_enum {
* raisins, and once those are gone this will be removed. * raisins, and once those are gone this will be removed.
* *
* Returns: * Returns:
* MUTEX_TRYLOCK_FAILED - trylock failed, * - MUTEX_TRYLOCK_FAILED - trylock failed,
* MUTEX_TRYLOCK_SUCCESS - lock acquired, * - MUTEX_TRYLOCK_SUCCESS - lock acquired,
* MUTEX_TRYLOCK_RECURSIVE - we already owned the lock. * - MUTEX_TRYLOCK_RECURSIVE - we already owned the lock.
*/ */
static inline /* __deprecated */ __must_check enum mutex_trylock_recursive_enum static inline /* __deprecated */ __must_check enum mutex_trylock_recursive_enum
mutex_trylock_recursive(struct mutex *lock) mutex_trylock_recursive(struct mutex *lock)

40
kernel/futex.c
View File

@ -488,7 +488,7 @@ static void drop_futex_key_refs(union futex_key *key)
* *
* Return: a negative error code or 0 * Return: a negative error code or 0
* *
* The key words are stored in *key on success. * The key words are stored in @key on success.
* *
* For shared mappings, it's (page->index, file_inode(vma->vm_file), * For shared mappings, it's (page->index, file_inode(vma->vm_file),
* offset_within_page). For private mappings, it's (uaddr, current->mm). * offset_within_page). For private mappings, it's (uaddr, current->mm).
@ -1259,9 +1259,9 @@ static int lock_pi_update_atomic(u32 __user *uaddr, u32 uval, u32 newval)
* @set_waiters: force setting the FUTEX_WAITERS bit (1) or not (0) * @set_waiters: force setting the FUTEX_WAITERS bit (1) or not (0)
* *
* Return: * Return:
* 0 - ready to wait; * - 0 - ready to wait;
* 1 - acquired the lock; * - 1 - acquired the lock;
* <0 - error * - <0 - error
* *
* The hb->lock and futex_key refs shall be held by the caller. * The hb->lock and futex_key refs shall be held by the caller.
*/ */
@ -1717,9 +1717,9 @@ void requeue_pi_wake_futex(struct futex_q *q, union futex_key *key,
* hb1 and hb2 must be held by the caller. * hb1 and hb2 must be held by the caller.
* *
* Return: * Return:
* 0 - failed to acquire the lock atomically; * - 0 - failed to acquire the lock atomically;
* >0 - acquired the lock, return value is vpid of the top_waiter * - >0 - acquired the lock, return value is vpid of the top_waiter
* <0 - error * - <0 - error
*/ */
static int futex_proxy_trylock_atomic(u32 __user *pifutex, static int futex_proxy_trylock_atomic(u32 __user *pifutex,
struct futex_hash_bucket *hb1, struct futex_hash_bucket *hb1,
@ -1785,8 +1785,8 @@ static int futex_proxy_trylock_atomic(u32 __user *pifutex,
* uaddr2 atomically on behalf of the top waiter. * uaddr2 atomically on behalf of the top waiter.
* *
* Return: * Return:
* >=0 - on success, the number of tasks requeued or woken; * - >=0 - on success, the number of tasks requeued or woken;
* <0 - on error * - <0 - on error
*/ */
static int futex_requeue(u32 __user *uaddr1, unsigned int flags, static int futex_requeue(u32 __user *uaddr1, unsigned int flags,
u32 __user *uaddr2, int nr_wake, int nr_requeue, u32 __user *uaddr2, int nr_wake, int nr_requeue,
@ -2142,8 +2142,8 @@ static inline void queue_me(struct futex_q *q, struct futex_hash_bucket *hb)
* be paired with exactly one earlier call to queue_me(). * be paired with exactly one earlier call to queue_me().
* *
* Return: * Return:
* 1 - if the futex_q was still queued (and we removed unqueued it); * - 1 - if the futex_q was still queued (and we removed unqueued it);
* 0 - if the futex_q was already removed by the waking thread * - 0 - if the futex_q was already removed by the waking thread
*/ */
static int unqueue_me(struct futex_q *q) static int unqueue_me(struct futex_q *q)
{ {
@ -2333,9 +2333,9 @@ static long futex_wait_restart(struct restart_block *restart);
* acquire the lock. Must be called with the hb lock held. * acquire the lock. Must be called with the hb lock held.
* *
* Return: * Return:
* 1 - success, lock taken; * - 1 - success, lock taken;
* 0 - success, lock not taken; * - 0 - success, lock not taken;
* <0 - on error (-EFAULT) * - <0 - on error (-EFAULT)
*/ */
static int fixup_owner(u32 __user *uaddr, struct futex_q *q, int locked) static int fixup_owner(u32 __user *uaddr, struct futex_q *q, int locked)
{ {
@ -2422,8 +2422,8 @@ static void futex_wait_queue_me(struct futex_hash_bucket *hb, struct futex_q *q,
* with no q.key reference on failure. * with no q.key reference on failure.
* *
* Return: * Return:
* 0 - uaddr contains val and hb has been locked; * - 0 - uaddr contains val and hb has been locked;
* <1 - -EFAULT or -EWOULDBLOCK (uaddr does not contain val) and hb is unlocked * - <1 - -EFAULT or -EWOULDBLOCK (uaddr does not contain val) and hb is unlocked
*/ */
static int futex_wait_setup(u32 __user *uaddr, u32 val, unsigned int flags, static int futex_wait_setup(u32 __user *uaddr, u32 val, unsigned int flags,
struct futex_q *q, struct futex_hash_bucket **hb) struct futex_q *q, struct futex_hash_bucket **hb)
@ -2895,8 +2895,8 @@ pi_faulted:
* called with the hb lock held. * called with the hb lock held.
* *
* Return: * Return:
* 0 = no early wakeup detected; * - 0 = no early wakeup detected;
* <0 = -ETIMEDOUT or -ERESTARTNOINTR * - <0 = -ETIMEDOUT or -ERESTARTNOINTR
*/ */
static inline static inline
int handle_early_requeue_pi_wakeup(struct futex_hash_bucket *hb, int handle_early_requeue_pi_wakeup(struct futex_hash_bucket *hb,
@ -2968,8 +2968,8 @@ int handle_early_requeue_pi_wakeup(struct futex_hash_bucket *hb,
* If 4 or 7, we cleanup and return with -ETIMEDOUT. * If 4 or 7, we cleanup and return with -ETIMEDOUT.
* *
* Return: * Return:
* 0 - On success; * - 0 - On success;
* <0 - On error * - <0 - On error
*/ */
static int futex_wait_requeue_pi(u32 __user *uaddr, unsigned int flags, static int futex_wait_requeue_pi(u32 __user *uaddr, unsigned int flags,
u32 val, ktime_t *abs_time, u32 bitset, u32 val, ktime_t *abs_time, u32 bitset,

6
kernel/locking/mutex.c
View File

@ -227,9 +227,9 @@ static void __sched __mutex_lock_slowpath(struct mutex *lock);
* (or statically defined) before it can be locked. memset()-ing * (or statically defined) before it can be locked. memset()-ing
* the mutex to 0 is not allowed. * the mutex to 0 is not allowed.
* *
* ( The CONFIG_DEBUG_MUTEXES .config option turns on debugging * (The CONFIG_DEBUG_MUTEXES .config option turns on debugging
* checks that will enforce the restrictions and will also do * checks that will enforce the restrictions and will also do
* deadlock debugging. ) * deadlock debugging)
* *
* This function is similar to (but not equivalent to) down(). * This function is similar to (but not equivalent to) down().
*/ */