Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit a8d89807 authored by Viral Mehta's avatar Viral Mehta Committed by Jiri Kosina
Browse files

kfifo: fix kerneldoc for kfifo_avail and kfifo_in_locked 



Function argument is not having "len" anywhere;
"len" is later used in kfifo_{in|out}.

So here, it would be appropriate to say,
it copies @n bytes and not @len

Signed-off-by: default avatarViral Mehta <viral.mehta@lntinfotech.com>
Signed-off-by: default avatarJiri Kosina <jkosina@suse.cz>
parent 9c5fb19a

include/linux/kfifo.h

+2 −2
Original line number Original line Diff line number Diff line
@@ -202,7 +202,7 @@ static inline __must_check unsigned int kfifo_avail(struct kfifo *fifo) 
 * @n: the length of the data to be added.

 * @n: the length of the data to be added.

 * @lock: pointer to the spinlock to use for locking.

 * @lock: pointer to the spinlock to use for locking.

 *

 *

 * This function copies at most @len bytes from the @from buffer into

 * This function copies at most @n bytes from the @from buffer into

 * the FIFO depending on the free space, and returns the number of

 * the FIFO depending on the free space, and returns the number of

 * bytes copied.

 * bytes copied.

 */

 */
@@ -228,7 +228,7 @@ static inline unsigned int kfifo_in_locked(struct kfifo *fifo, 
 * @n: the size of the destination buffer.

 * @n: the size of the destination buffer.

 * @lock: pointer to the spinlock to use for locking.

 * @lock: pointer to the spinlock to use for locking.

 *

 *

 * This function copies at most @len bytes from the FIFO into the

 * This function copies at most @n bytes from the FIFO into the

 * @to buffer and returns the number of copied bytes.

 * @to buffer and returns the number of copied bytes.

 */

 */

static inline __must_check unsigned int kfifo_out_locked(struct kfifo *fifo,

static inline __must_check unsigned int kfifo_out_locked(struct kfifo *fifo,