diff mbox series

[-next] fs: Fix one kernel-doc comment

Message ID 20230811014359.4960-1-yang.lee@linux.alibaba.com
State New
Headers
Series [-next] fs: Fix one kernel-doc comment |

Commit Message

Yang Li Aug. 11, 2023, 1:43 a.m. UTC 
  Fix one kernel-doc comment to silence the warning:

fs/read_write.c:88: warning: Function parameter or member 'maxsize' not described in 'generic_file_llseek_size'

Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
---
 fs/read_write.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Randy Dunlap Aug. 11, 2023, 5:03 a.m. UTC | #1 
On 8/10/23 18:43, Yang Li wrote:
> Fix one kernel-doc comment to silence the warning:
> 
> fs/read_write.c:88: warning: Function parameter or member 'maxsize' not described in 'generic_file_llseek_size'
> 
> Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Thanks.

> ---
>  fs/read_write.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/fs/read_write.c b/fs/read_write.c
> index b07de77ef126..4771701c896b 100644
> --- a/fs/read_write.c
> +++ b/fs/read_write.c
> @@ -71,7 +71,7 @@ EXPORT_SYMBOL(vfs_setpos);
>   * @file:	file structure to seek on
>   * @offset:	file offset to seek to
>   * @whence:	type of seek
> - * @size:	max size of this file in file system
> + * @maxsize:	max size of this file in file system
>   * @eof:	offset used for SEEK_END position
>   *
>   * This is a variant of generic_file_llseek that allows passing in a custom
Christian Brauner Aug. 11, 2023, 6:58 a.m. UTC | #2 
On Fri, 11 Aug 2023 09:43:59 +0800, Yang Li wrote:
> Fix one kernel-doc comment to silence the warning:
> 
> fs/read_write.c:88: warning: Function parameter or member 'maxsize' not described in 'generic_file_llseek_size'
> 
> 

Applied to the vfs.misc branch of the vfs/vfs.git tree.
Patches in the vfs.misc branch should appear in linux-next soon.

Please report any outstanding bugs that were missed during review in a
new review to the original patch series allowing us to drop it.

It's encouraged to provide Acked-bys and Reviewed-bys even though the
patch has now been applied. If possible patch trailers will be updated.

Note that commit hashes shown below are subject to change due to rebase,
trailer updates or similar. If in doubt, please check the listed branch.

tree:   https://git.kernel.org/pub/scm/linux/kernel/git/vfs/vfs.git
branch: vfs.misc

[1/1] fs: Fix one kernel-doc comment
      https://git.kernel.org/vfs/vfs/c/3e797ad1c5df
diff mbox series

Patch

diff --git a/fs/read_write.c b/fs/read_write.c
index b07de77ef126..4771701c896b 100644
--- a/fs/read_write.c
+++ b/fs/read_write.c
@@ -71,7 +71,7 @@  EXPORT_SYMBOL(vfs_setpos);
  * @file:	file structure to seek on
  * @offset:	file offset to seek to
  * @whence:	type of seek
- * @size:	max size of this file in file system
+ * @maxsize:	max size of this file in file system
  * @eof:	offset used for SEEK_END position
  *
  * This is a variant of generic_file_llseek that allows passing in a custom