Commit bc173f7092c76a7967f135c2b3a54052ad99733b

Authored by Randy Dunlap
Committed by Linus Torvalds
1 parent f4b5162820

kfifo: fix kernel-doc notation

Fix kfifo kernel-doc warnings:

Warning(kernel/kfifo.c:361): No description found for parameter 'total'
Warning(kernel/kfifo.c:402): bad line:  @ @lenout: pointer to output variable with copied data
Warning(kernel/kfifo.c:412): No description found for parameter 'lenout'

Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
Cc: Stefani Seibold <stefani@seibold.net>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>

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

... ... @@ -349,6 +349,7 @@
349 349 * @fifo: the fifo to be used.
350 350 * @from: pointer to the data to be added.
351 351 * @len: the length of the data to be added.
  352 + * @total: the actual returned data length.
352 353 *
353 354 * This function copies at most @len bytes from the @from into the
354 355 * FIFO depending and returns -EFAULT/0.
... ... @@ -399,7 +400,7 @@
399 400 * @fifo: the fifo to be used.
400 401 * @to: where the data must be copied.
401 402 * @len: the size of the destination buffer.
402   - @ @lenout: pointer to output variable with copied data
  403 + * @lenout: pointer to output variable with copied data
403 404 *
404 405 * This function copies at most @len bytes from the FIFO into the
405 406 * @to buffer and 0 or -EFAULT.