lkml.org 
[lkml]   [2019]   [Mar]   [27]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    Patch in this message
    /
    From
    Subject[PATCH AUTOSEL 5.0 034/262] docs/core-api/mm: fix user memory accessors formatting
    Date
    From: Mike Rapoport <rppt@linux.ibm.com>

    [ Upstream commit bc8ff3ca6589d63c6d10f5ee8bed38f74851b469 ]

    The descriptions of userspace memory access functions had minor issues
    with formatting that made kernel-doc unable to properly detect the
    function/macro names and the return value sections:

    ./arch/x86/include/asm/uaccess.h:80: info: Scanning doc for
    ./arch/x86/include/asm/uaccess.h:139: info: Scanning doc for
    ./arch/x86/include/asm/uaccess.h:231: info: Scanning doc for
    ./arch/x86/include/asm/uaccess.h:505: info: Scanning doc for
    ./arch/x86/include/asm/uaccess.h:530: info: Scanning doc for
    ./arch/x86/lib/usercopy_32.c:58: info: Scanning doc for
    ./arch/x86/lib/usercopy_32.c:69: warning: No description found for return
    value of 'clear_user'
    ./arch/x86/lib/usercopy_32.c:78: info: Scanning doc for
    ./arch/x86/lib/usercopy_32.c:90: warning: No description found for return
    value of '__clear_user'

    Fix the formatting.

    Link: http://lkml.kernel.org/r/1549549644-4903-3-git-send-email-rppt@linux.ibm.com
    Signed-off-by: Mike Rapoport <rppt@linux.ibm.com>
    Reviewed-by: Andrew Morton <akpm@linux-foundation.org>
    Cc: Jonathan Corbet <corbet@lwn.net>
    Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
    Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
    Signed-off-by: Sasha Levin <sashal@kernel.org>
    ---
    arch/x86/include/asm/uaccess.h | 24 ++++++++++++------------
    arch/x86/lib/usercopy_32.c | 8 ++++----
    2 files changed, 16 insertions(+), 16 deletions(-)

    diff --git a/arch/x86/include/asm/uaccess.h b/arch/x86/include/asm/uaccess.h
    index c1334aaaa78d..f3aed639dccd 100644
    --- a/arch/x86/include/asm/uaccess.h
    +++ b/arch/x86/include/asm/uaccess.h
    @@ -76,7 +76,7 @@ static inline bool __chk_range_not_ok(unsigned long addr, unsigned long size, un
    #endif

    /**
    - * access_ok: - Checks if a user space pointer is valid
    + * access_ok - Checks if a user space pointer is valid
    * @addr: User space pointer to start of block to check
    * @size: Size of block to check
    *
    @@ -85,12 +85,12 @@ static inline bool __chk_range_not_ok(unsigned long addr, unsigned long size, un
    *
    * Checks if a pointer to a block of memory in user space is valid.
    *
    - * Returns true (nonzero) if the memory block may be valid, false (zero)
    - * if it is definitely invalid.
    - *
    * Note that, depending on architecture, this function probably just
    * checks that the pointer is in the user space range - after calling
    * this function, memory access functions may still return -EFAULT.
    + *
    + * Return: true (nonzero) if the memory block may be valid, false (zero)
    + * if it is definitely invalid.
    */
    #define access_ok(addr, size) \
    ({ \
    @@ -135,7 +135,7 @@ extern int __get_user_bad(void);
    __typeof__(__builtin_choose_expr(sizeof(x) > sizeof(0UL), 0ULL, 0UL))

    /**
    - * get_user: - Get a simple variable from user space.
    + * get_user - Get a simple variable from user space.
    * @x: Variable to store result.
    * @ptr: Source address, in user space.
    *
    @@ -149,7 +149,7 @@ __typeof__(__builtin_choose_expr(sizeof(x) > sizeof(0UL), 0ULL, 0UL))
    * @ptr must have pointer-to-simple-variable type, and the result of
    * dereferencing @ptr must be assignable to @x without a cast.
    *
    - * Returns zero on success, or -EFAULT on error.
    + * Return: zero on success, or -EFAULT on error.
    * On error, the variable @x is set to zero.
    */
    /*
    @@ -227,7 +227,7 @@ extern void __put_user_4(void);
    extern void __put_user_8(void);

    /**
    - * put_user: - Write a simple value into user space.
    + * put_user - Write a simple value into user space.
    * @x: Value to copy to user space.
    * @ptr: Destination address, in user space.
    *
    @@ -241,7 +241,7 @@ extern void __put_user_8(void);
    * @ptr must have pointer-to-simple-variable type, and @x must be assignable
    * to the result of dereferencing @ptr.
    *
    - * Returns zero on success, or -EFAULT on error.
    + * Return: zero on success, or -EFAULT on error.
    */
    #define put_user(x, ptr) \
    ({ \
    @@ -503,7 +503,7 @@ struct __large_struct { unsigned long buf[100]; };
    } while (0)

    /**
    - * __get_user: - Get a simple variable from user space, with less checking.
    + * __get_user - Get a simple variable from user space, with less checking.
    * @x: Variable to store result.
    * @ptr: Source address, in user space.
    *
    @@ -520,7 +520,7 @@ struct __large_struct { unsigned long buf[100]; };
    * Caller must check the pointer with access_ok() before calling this
    * function.
    *
    - * Returns zero on success, or -EFAULT on error.
    + * Return: zero on success, or -EFAULT on error.
    * On error, the variable @x is set to zero.
    */

    @@ -528,7 +528,7 @@ struct __large_struct { unsigned long buf[100]; };
    __get_user_nocheck((x), (ptr), sizeof(*(ptr)))

    /**
    - * __put_user: - Write a simple value into user space, with less checking.
    + * __put_user - Write a simple value into user space, with less checking.
    * @x: Value to copy to user space.
    * @ptr: Destination address, in user space.
    *
    @@ -545,7 +545,7 @@ struct __large_struct { unsigned long buf[100]; };
    * Caller must check the pointer with access_ok() before calling this
    * function.
    *
    - * Returns zero on success, or -EFAULT on error.
    + * Return: zero on success, or -EFAULT on error.
    */

    #define __put_user(x, ptr) \
    diff --git a/arch/x86/lib/usercopy_32.c b/arch/x86/lib/usercopy_32.c
    index bfd94e7812fc..7d290777246d 100644
    --- a/arch/x86/lib/usercopy_32.c
    +++ b/arch/x86/lib/usercopy_32.c
    @@ -54,13 +54,13 @@ do { \
    } while (0)

    /**
    - * clear_user: - Zero a block of memory in user space.
    + * clear_user - Zero a block of memory in user space.
    * @to: Destination address, in user space.
    * @n: Number of bytes to zero.
    *
    * Zero a block of memory in user space.
    *
    - * Returns number of bytes that could not be cleared.
    + * Return: number of bytes that could not be cleared.
    * On success, this will be zero.
    */
    unsigned long
    @@ -74,14 +74,14 @@ clear_user(void __user *to, unsigned long n)
    EXPORT_SYMBOL(clear_user);

    /**
    - * __clear_user: - Zero a block of memory in user space, with less checking.
    + * __clear_user - Zero a block of memory in user space, with less checking.
    * @to: Destination address, in user space.
    * @n: Number of bytes to zero.
    *
    * Zero a block of memory in user space. Caller must check
    * the specified block with access_ok() before calling this function.
    *
    - * Returns number of bytes that could not be cleared.
    + * Return: number of bytes that could not be cleared.
    * On success, this will be zero.
    */
    unsigned long
    --
    2.19.1
    \
     
     \ /
      Last update: 2019-03-27 20:35    [W:4.157 / U:0.136 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site