Commit 0fc377bd648d1935ea34665239e3f0a274b71698

Authored by Randy Dunlap
Committed by Linus Torvalds
1 parent 1f7f314bf2

sysctl: fix kernel-doc notation and typos

Fix kernel-doc warnings, kernel-doc special characters, and
typos in recent kernel/sysctl.c additions.

Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
Cc: Amerigo Wang <amwang@redhat.com>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>

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

... ... @@ -2083,20 +2083,20 @@
2083 2083  
2084 2084 #define TMPBUFLEN 22
2085 2085 /**
2086   - * proc_get_long - reads an ASCII formated integer from a user buffer
  2086 + * proc_get_long - reads an ASCII formatted integer from a user buffer
2087 2087 *
2088   - * @buf - a kernel buffer
2089   - * @size - size of the kernel buffer
2090   - * @val - this is where the number will be stored
2091   - * @neg - set to %TRUE if number is negative
2092   - * @perm_tr - a vector which contains the allowed trailers
2093   - * @perm_tr_len - size of the perm_tr vector
2094   - * @tr - pointer to store the trailer character
  2088 + * @buf: a kernel buffer
  2089 + * @size: size of the kernel buffer
  2090 + * @val: this is where the number will be stored
  2091 + * @neg: set to %TRUE if number is negative
  2092 + * @perm_tr: a vector which contains the allowed trailers
  2093 + * @perm_tr_len: size of the perm_tr vector
  2094 + * @tr: pointer to store the trailer character
2095 2095 *
2096   - * In case of success 0 is returned and buf and size are updated with
2097   - * the amount of bytes read. If tr is non NULL and a trailing
2098   - * character exist (size is non zero after returning from this
2099   - * function) tr is updated with the trailing character.
  2096 + * In case of success %0 is returned and @buf and @size are updated with
  2097 + * the amount of bytes read. If @tr is non-NULL and a trailing
  2098 + * character exists (size is non-zero after returning from this
  2099 + * function), @tr is updated with the trailing character.
2100 2100 */
2101 2101 static int proc_get_long(char **buf, size_t *size,
2102 2102 unsigned long *val, bool *neg,
2103 2103  
2104 2104  
... ... @@ -2147,15 +2147,15 @@
2147 2147 }
2148 2148  
2149 2149 /**
2150   - * proc_put_long - coverts an integer to a decimal ASCII formated string
  2150 + * proc_put_long - converts an integer to a decimal ASCII formatted string
2151 2151 *
2152   - * @buf - the user buffer
2153   - * @size - the size of the user buffer
2154   - * @val - the integer to be converted
2155   - * @neg - sign of the number, %TRUE for negative
  2152 + * @buf: the user buffer
  2153 + * @size: the size of the user buffer
  2154 + * @val: the integer to be converted
  2155 + * @neg: sign of the number, %TRUE for negative
2156 2156 *
2157   - * In case of success 0 is returned and buf and size are updated with
2158   - * the amount of bytes read.
  2157 + * In case of success %0 is returned and @buf and @size are updated with
  2158 + * the amount of bytes written.
2159 2159 */
2160 2160 static int proc_put_long(void __user **buf, size_t *size, unsigned long val,
2161 2161 bool neg)