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

Commit 6d1029b5 authored by Akinobu Mita's avatar Akinobu Mita Committed by Linus Torvalds
Browse files

add kernel-doc for simple_read_from_buffer and memory_read_from_buffer 



Add kernel-doc comments describing simple_read_from_buffer and
memory_read_from_buffer.

Signed-off-by: default avatarAkinobu Mita <akinobu.mita@gmail.com>
Cc: Christoph Hellwig <hch@lst.de>
Cc: "Randy.Dunlap" <rdunlap@xenotime.net>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
Signed-off-by: default avatarLinus Torvalds <torvalds@linux-foundation.org>
parent 337e2ab5

fs/libfs.c

+28 −0
Original line number Diff line number Diff line
@@ -512,6 +512,20 @@ void simple_release_fs(struct vfsmount **mount, int *count) 
	mntput(mnt);

}



/**

 * simple_read_from_buffer - copy data from the buffer to user space

 * @to: the user space buffer to read to

 * @count: the maximum number of bytes to read

 * @ppos: the current position in the buffer

 * @from: the buffer to read from

 * @available: the size of the buffer

 *

 * The simple_read_from_buffer() function reads up to @count bytes from the

 * buffer @from at offset @ppos into the user space address starting at @to.

 *

 * On success, the number of bytes read is returned and the offset @ppos is

 * advanced by this number, or negative value is returned on error.

 **/

ssize_t simple_read_from_buffer(void __user *to, size_t count, loff_t *ppos,

				const void *from, size_t available)

{
@@ -528,6 +542,20 @@ ssize_t simple_read_from_buffer(void __user *to, size_t count, loff_t *ppos, 
	return count;

}



/**

 * memory_read_from_buffer - copy data from the buffer

 * @to: the kernel space buffer to read to

 * @count: the maximum number of bytes to read

 * @ppos: the current position in the buffer

 * @from: the buffer to read from

 * @available: the size of the buffer

 *

 * The memory_read_from_buffer() function reads up to @count bytes from the

 * buffer @from at offset @ppos into the kernel space address starting at @to.

 *

 * On success, the number of bytes read is returned and the offset @ppos is

 * advanced by this number, or negative value is returned on error.

 **/

ssize_t memory_read_from_buffer(void *to, size_t count, loff_t *ppos,

				const void *from, size_t available)

{