aboutsummaryrefslogtreecommitdiffstats
path: root/arch/x86/lib
diff options
context:
space:
mode:
authorMike Rapoport <rppt@linux.ibm.com>2019-03-05 18:48:39 -0500
committerLinus Torvalds <torvalds@linux-foundation.org>2019-03-06 00:07:20 -0500
commitbc8ff3ca6589d63c6d10f5ee8bed38f74851b469 (patch)
tree3373d285e21d3f351264240938bdf86f842feabe /arch/x86/lib
parent92eac16819e47ab919bd8f28ed49f8fadad0954e (diff)
docs/core-api/mm: fix user memory accessors formatting
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>
Diffstat (limited to 'arch/x86/lib')
-rw-r--r--arch/x86/lib/usercopy_32.c8
1 files changed, 4 insertions, 4 deletions
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 { \
54} while (0) 54} while (0)
55 55
56/** 56/**
57 * clear_user: - Zero a block of memory in user space. 57 * clear_user - Zero a block of memory in user space.
58 * @to: Destination address, in user space. 58 * @to: Destination address, in user space.
59 * @n: Number of bytes to zero. 59 * @n: Number of bytes to zero.
60 * 60 *
61 * Zero a block of memory in user space. 61 * Zero a block of memory in user space.
62 * 62 *
63 * Returns number of bytes that could not be cleared. 63 * Return: number of bytes that could not be cleared.
64 * On success, this will be zero. 64 * On success, this will be zero.
65 */ 65 */
66unsigned long 66unsigned long
@@ -74,14 +74,14 @@ clear_user(void __user *to, unsigned long n)
74EXPORT_SYMBOL(clear_user); 74EXPORT_SYMBOL(clear_user);
75 75
76/** 76/**
77 * __clear_user: - Zero a block of memory in user space, with less checking. 77 * __clear_user - Zero a block of memory in user space, with less checking.
78 * @to: Destination address, in user space. 78 * @to: Destination address, in user space.
79 * @n: Number of bytes to zero. 79 * @n: Number of bytes to zero.
80 * 80 *
81 * Zero a block of memory in user space. Caller must check 81 * Zero a block of memory in user space. Caller must check
82 * the specified block with access_ok() before calling this function. 82 * the specified block with access_ok() before calling this function.
83 * 83 *
84 * Returns number of bytes that could not be cleared. 84 * Return: number of bytes that could not be cleared.
85 * On success, this will be zero. 85 * On success, this will be zero.
86 */ 86 */
87unsigned long 87unsigned long